{ "openapi": "3.1.0", "servers": [ { "url": "https://api.printago.io", "description": "Prod" } ], "info": { "version": "0.0.1", "title": "@printago/api", "description": "", "license": { "name": "UNLICENSED" } }, "paths": { "/v1/parts": { "get": { "summary": "Get all parts", "description": "List all parts in your store", "tags": [ "Parts" ], "parameters": [ { "name": "name", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "type", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "description", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "fileUris", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "fileHashes", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "thumbnailUri", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "parameters", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "printTags", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "overriddenProcessProfileId", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "folderId", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "materials", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "slicerOverride", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "metadata", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "slicingEstimate", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "use3MFProcessProfile", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "arrangeable", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "userTags", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "gcodePlateUris", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "uploadedAt", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "id", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "storeId", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "createdAt", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "updatedAt", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "sort", "in": "query", "schema": { "type": "string" }, "required": false, "title": "Sort" }, { "name": "limit", "in": "query", "schema": { "type": "number", "minimum": 1, "maximum": 1000 }, "required": false, "title": "Limit" }, { "name": "offset", "in": "query", "schema": { "type": "number", "minimum": 0 }, "required": false, "title": "Offset" }, { "name": "fields", "in": "query", "schema": { "type": "string" }, "required": false, "title": "Fields" }, { "name": "include", "in": "query", "schema": { "type": "string" }, "required": false, "title": "Include" }, { "name": "meta", "in": "query", "schema": { "type": "boolean" }, "required": false, "title": "Meta" }, { "name": "hints", "in": "query", "schema": { "type": "boolean" }, "required": false, "title": "Hints" } ], "responses": { "200": { "description": "List of all parts with their file info and metadata", "content": { "application/json": { "schema": { "oneOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/Part" } }, { "$ref": "#/components/schemas/SearchResponse" } ] } } } } }, "x-permission": "part.view" }, "post": { "summary": "Create a new part", "description": "Upload a new 3D model file. Supports STL, 3MF, STEP, GCODE, and OpenSCAD formats.\nAfter upload, metadata is automatically extracted from the file.", "tags": [ "Parts" ], "parameters": [], "requestBody": { "description": "Part data including file URIs and optional material assignments", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartInsertWithMaterials" } } }, "required": true }, "responses": { "201": { "description": "The created part", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Part" } } } } }, "x-permission": "part.create" }, "patch": { "summary": "Bulk update parts", "description": "Update the same fields on multiple parts at once", "tags": [ "Parts" ], "parameters": [], "requestBody": { "description": "Part IDs and shared update data", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateManyRequestPartUpdateWithMaterials" } } }, "required": true }, "responses": { "200": { "description": "Updated parts", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Part" } } } } } }, "x-permission": "part.edit" }, "delete": { "summary": "Delete multiple parts", "description": "Delete multiple parts and their associated files", "tags": [ "Parts" ], "parameters": [], "requestBody": { "description": "Array of part IDs to delete", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string", "pattern": "^[a-z0-9]{24}$" } } } }, "required": true }, "responses": { "200": { "description": "IDs of successfully deleted parts", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string", "pattern": "^[a-z0-9]{24}$" } } } } } }, "x-permission": "part.delete" } }, "/v1/parts/search": { "post": { "summary": "Search parts", "description": "Search parts with complex filters", "tags": [ "Parts" ], "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchQueryDtoPart" } } }, "required": true }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchResponse" } } } } }, "x-permission": "part.view" } }, "/v1/parts/{id}": { "get": { "summary": "Get part by ID", "description": "Get a single part by ID", "tags": [ "Parts" ], "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true, "description": " The part's unique identifier" } ], "responses": { "200": { "description": "The requested part with full details", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Part" } } } } }, "x-permission": "part.view" }, "patch": { "summary": "Update a part", "description": "Update part properties like name, description, or material assignments", "tags": [ "Parts" ], "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true, "description": " The part's unique identifier" } ], "requestBody": { "description": "Fields to update", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartUpdateWithMaterials" } } }, "required": true }, "responses": { "200": { "description": "The updated part", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Part" } } } } }, "x-permission": "part.edit" }, "delete": { "summary": "Delete a part", "description": "Delete a single part and its associated files", "tags": [ "Parts" ], "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true, "description": " The part's unique identifier" } ], "responses": { "200": { "description": "IDs of deleted resources", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } } }, "x-permission": "part.delete" } }, "/v1/parts/create-skus": { "post": { "summary": "Create SKUs from parts", "description": "Create SKU products from selected parts. Each part becomes a new SKU\nwith the part linked to it.", "tags": [ "Parts", "SKUs" ], "parameters": [], "requestBody": { "description": "Array of part-to-SKU mappings with custom names", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "partId": { "type": "string" }, "skuName": { "type": "string" } }, "required": [ "partId", "skuName" ] } } } }, "required": true }, "responses": { "201": { "description": "The created SKUs", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Sku" } } } } } }, "x-permission": "sku.create" } }, "/v1/parts/{id}/split-plates": { "post": { "summary": "Split multi-plate 3MF file", "description": "Split a multi-plate GCODE3MF file into separate files for each plate.\nUseful for sending individual plates to different printers.", "tags": [ "Parts" ], "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true, "description": " The GCODE3MF part's unique identifier" } ], "responses": { "201": { "description": "The updated part with plate file URIs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Part" } } } } }, "x-permission": "part.edit" } }, "/v1/printers/set-config": { "patch": { "summary": "Set provider config", "description": "Configure printer provider settings (e.g., Bambu Lab cloud connection)", "tags": [ "Printers" ], "parameters": [], "requestBody": { "description": "Provider configuration for selected printers", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetProviderConfig" } } }, "required": true }, "responses": { "200": { "description": "Updated printers", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Printer" } } } } } }, "x-permission": "printer.config" } }, "/v1/printers/confirm-ready": { "patch": { "summary": "Confirm printer ready", "description": "Mark printers as ready or not ready to receive jobs", "tags": [ "Printers" ], "parameters": [], "requestBody": { "description": "Printer IDs and ready status", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfirmReadyRequest" } } }, "required": true }, "responses": { "200": { "description": "Updated printers", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Printer" } } } } } }, "x-permission": "printer.ready" } }, "/v1/printers/enabled": { "patch": { "summary": "Set printer enabled status", "description": "Enable or disable printers for automatic job assignment", "tags": [ "Printers" ], "parameters": [], "requestBody": { "description": "Printer IDs and enabled status", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnabledConfig" } } }, "required": true }, "responses": { "200": { "description": "Updated printers", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Printer" } } } } } }, "x-permission": "printer.control" } }, "/v1/printers/continous-print": { "patch": { "summary": "Set Fabmatic", "description": "Enable or disable Fabmatic (continuous printing) for printers", "tags": [ "Printers" ], "parameters": [], "requestBody": { "description": "Printer IDs, enabled status, and optional job limit", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContinuousPrintConfig" } } }, "required": true }, "responses": { "200": { "description": "Updated printers", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Printer" } } } } } }, "x-permission": "printer.config, printer.ready" } }, "/v1/printers": { "get": { "summary": "Get all printers", "description": "List all printers connected to your store", "tags": [ "Printers" ], "parameters": [ { "name": "provider", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "deviceId", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "providerConfig", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "machineUserProfileId", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "machineSystemProfileId", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "processUserProfileId", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "processSystemProfileId", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "name", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "nozzleDiameter", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "metadata", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "proxyClientId", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "commMethod", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "enabled", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "tags", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "confirmedReady", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "isAvailable", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "isOnline", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "printingJobId", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "lastPrintedAt", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "integrationId", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "integrationType", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "continuousPrint", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "fabmaticRemainingJobs", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "modelName", "in": "query", "schema": { "type": "string" }, "required": false, "description": "Human-readable model name (e.g. \"P1S\", \"Snapmaker U1\", \"Prusa CORE One\")" }, { "name": "vendorName", "in": "query", "schema": { "type": "string" }, "required": false, "description": "Vendor/manufacturer name (e.g. \"Bambu Lab\", \"Prusa\", \"Snapmaker\")" }, { "name": "vendorModelId", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "printerCapabilityPatch", "in": "query", "schema": { "type": "string" }, "required": false, "title": "Per-printer capability override applied last (web Advanced Capabilities panel)", "description": "Per-printer capability override applied last (web Advanced Capabilities panel)." }, { "name": "printerAdapterBindingsPatch", "in": "query", "schema": { "type": "string" }, "required": false, "title": "Per-printer adapter binding override applied last", "description": "Per-printer adapter binding override applied last." }, { "name": "lifetimePrintHours", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "lifetimeJobCount", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "isInMaintenance", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "lastMaintenanceOfflineAt", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "lastMaintenanceOnlineAt", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "id", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "storeId", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "createdAt", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "updatedAt", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "sort", "in": "query", "schema": { "type": "string" }, "required": false, "title": "Sort" }, { "name": "limit", "in": "query", "schema": { "type": "number", "minimum": 1, "maximum": 1000 }, "required": false, "title": "Limit" }, { "name": "offset", "in": "query", "schema": { "type": "number", "minimum": 0 }, "required": false, "title": "Offset" }, { "name": "fields", "in": "query", "schema": { "type": "string" }, "required": false, "title": "Fields" }, { "name": "include", "in": "query", "schema": { "type": "string" }, "required": false, "title": "Include" }, { "name": "meta", "in": "query", "schema": { "type": "boolean" }, "required": false, "title": "Meta" }, { "name": "hints", "in": "query", "schema": { "type": "boolean" }, "required": false, "title": "Hints" } ], "responses": { "200": { "description": "All registered printers with status", "content": { "application/json": { "schema": { "oneOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/Printer" } }, { "$ref": "#/components/schemas/SearchResponse" } ] } } } } }, "x-permission": "printer.view" }, "patch": { "summary": "Bulk update printers", "description": "Update the same fields on multiple printers", "tags": [ "Printers" ], "parameters": [], "requestBody": { "description": "Printer IDs and shared update data", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateManyRequestPrinterUpdate" } } }, "required": true }, "responses": { "200": { "description": "Updated printers", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Printer" } } } } } }, "x-permission": "printer.edit" }, "delete": { "summary": "Delete multiple printers", "description": "Remove multiple printers from your store", "tags": [ "Printers" ], "parameters": [], "requestBody": { "description": "Printer IDs to delete", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkActionRequest" } } }, "required": true }, "responses": { "200": { "description": "IDs of deleted printers", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } } }, "x-permission": "printer.delete" } }, "/v1/printers/search": { "post": { "summary": "Search printers", "description": "Search printers with complex filters", "tags": [ "Printers" ], "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchQueryDtoPrinter" } } }, "required": true }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchResponse" } } } } }, "x-permission": "printer.view" } }, "/v1/printers/{id}/snapshot": { "get": { "summary": "Get latest camera snapshot URL", "description": "Get a signed URL for the most recent camera snapshot of a printer.\nThe URL is valid for 60 minutes; refresh by calling again before\n`expiresAt`. Snapshots are uploaded by Fuse on a printing-aware\ncadence (~30s while printing, ~10min while idle), so the URL may\npoint to an image up to 10 minutes old on an idle printer.\n\nThe endpoint signs the URL without checking whether the underlying\nobject exists, so the returned URL will return `404` from Firebase\nStorage when fetched if Fuse has not yet uploaded a snapshot for\nthis printer (brand-new pairing, snapshots disabled for the store,\nthe printer model has no camera, or the printer has been offline\nsince pairing). Callers should treat a 404 on the GET as \"no\nsnapshot available yet\" rather than an error. The endpoint itself\nonly returns 404 if the printer ID does not exist in your store.", "tags": [ "Printers" ], "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true, "description": " The printer's unique identifier" } ], "responses": { "200": { "description": "Signed download URL and expiry timestamp", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrinterLatestSnapshot" } } } } }, "x-permission": "printer.camera" } }, "/v1/printers/{id}": { "get": { "summary": "Get printer by ID", "description": "Get a single printer by ID", "tags": [ "Printers" ], "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true, "description": " The printer's unique identifier" } ], "responses": { "200": { "description": "The requested printer", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Printer" } } } } }, "x-permission": "printer.view" }, "patch": { "summary": "Update a printer", "description": "Update a printer's properties", "tags": [ "Printers" ], "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true, "description": " The printer's unique identifier" } ], "requestBody": { "description": "Fields to update", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartialPrinterUpdate" } } }, "required": true }, "responses": { "200": { "description": "The updated printer", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Printer" } } } } }, "x-permission": "printer.edit" }, "delete": { "summary": "Delete a printer", "description": "Remove a printer from your store", "tags": [ "Printers" ], "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true, "description": " The printer's unique identifier" } ], "responses": { "200": { "description": "IDs of deleted resources", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } } }, "x-permission": "printer.delete" } }, "/v1/printers/{id}/capabilities": { "get": { "summary": "Get resolved capabilities", "description": "Resolve effective capabilities for one printer.", "tags": [ "Printers" ], "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "oneOf": [ { "type": "null" }, { "type": "object", "properties": { "nozzles": { "type": "array", "items": { "type": "object", "properties": { "temperature": { "type": "object", "properties": { "read": { "type": "boolean" }, "set": { "type": "boolean" } } }, "extrude": { "type": "boolean" }, "toolRef": { "type": "string" }, "ref": { "type": "string", "title": "Logical reference, unique within its array. ASCII, lowercase, deterministic", "description": "Logical reference, unique within its array. ASCII, lowercase, deterministic." }, "label": { "type": "string", "description": "Human-readable display name" }, "kind": { "type": "string", "description": "Optional vendor/extensible subtype when the base role is not enough" } } } }, "tools": { "type": "array", "items": { "type": "object", "properties": { "selectable": { "type": "boolean" }, "nozzleRefs": { "type": "array", "items": { "type": "string" } }, "fanRefs": { "type": "array", "items": { "type": "string" } }, "sensorRefs": { "type": "array", "items": { "type": "string" } }, "ref": { "type": "string", "title": "Logical reference, unique within its array. ASCII, lowercase, deterministic", "description": "Logical reference, unique within its array. ASCII, lowercase, deterministic." }, "label": { "type": "string", "description": "Human-readable display name" }, "kind": { "type": "string", "description": "Optional vendor/extensible subtype when the base role is not enough" } } } }, "fans": { "type": "array", "items": { "type": "object", "properties": { "role": { "oneOf": [ { "const": "part" }, { "const": "aux" }, { "const": "chamber" }, { "const": "hotend" }, { "const": "exhaust" }, { "type": "object", "properties": { "length": { "type": "number", "title": "Returns the length of a String object", "description": "Returns the length of a String object." } }, "additionalProperties": { "type": "string" } } ] }, "controllable": { "type": "boolean" }, "reportsSpeed": { "type": "boolean", "description": "Whether the printer reports back a live fan speed. Defaults to true\n(omitted). Set false for write-only fans (e.g. OctoPrint, whose REST API\naccepts M106 but never surfaces a speed) so diagnostics skip the readback\nverification instead of failing a check they can't perform." }, "nozzleRef": { "type": "string" }, "toolRef": { "type": "string" }, "ref": { "type": "string", "title": "Logical reference, unique within its array. ASCII, lowercase, deterministic", "description": "Logical reference, unique within its array. ASCII, lowercase, deterministic." }, "label": { "type": "string", "description": "Human-readable display name" }, "kind": { "type": "string", "description": "Optional vendor/extensible subtype when the base role is not enough" } } } }, "lights": { "type": "array", "items": { "type": "object", "properties": { "role": { "oneOf": [ { "const": "chamber" }, { "const": "work" }, { "const": "indicator" }, { "const": "strip" }, { "type": "object", "properties": { "length": { "type": "number", "title": "Returns the length of a String object", "description": "Returns the length of a String object." } }, "additionalProperties": { "type": "string" } } ] }, "dimmable": { "type": "boolean" }, "ref": { "type": "string", "title": "Logical reference, unique within its array. ASCII, lowercase, deterministic", "description": "Logical reference, unique within its array. ASCII, lowercase, deterministic." }, "label": { "type": "string", "description": "Human-readable display name" }, "kind": { "type": "string", "description": "Optional vendor/extensible subtype when the base role is not enough" } } } }, "sensors": { "type": "array", "items": { "type": "object", "properties": { "role": { "oneOf": [ { "const": "lidar" }, { "const": "filament_runout" }, { "const": "door" }, { "const": "accelerometer" }, { "const": "bed_mesh" }, { "type": "object", "properties": { "length": { "type": "number", "title": "Returns the length of a String object", "description": "Returns the length of a String object." } }, "additionalProperties": { "type": "string" } } ] }, "nozzleRef": { "type": "string" }, "toolRef": { "type": "string" }, "ref": { "type": "string", "title": "Logical reference, unique within its array. ASCII, lowercase, deterministic", "description": "Logical reference, unique within its array. ASCII, lowercase, deterministic." }, "label": { "type": "string", "description": "Human-readable display name" }, "kind": { "type": "string", "description": "Optional vendor/extensible subtype when the base role is not enough" } } } }, "beds": { "type": "array", "items": { "type": "object", "properties": { "temperature": { "type": "object", "properties": { "read": { "type": "boolean" }, "set": { "type": "boolean" } } }, "hasMesh": { "type": "boolean" }, "ref": { "type": "string", "title": "Logical reference, unique within its array. ASCII, lowercase, deterministic", "description": "Logical reference, unique within its array. ASCII, lowercase, deterministic." }, "label": { "type": "string", "description": "Human-readable display name" }, "kind": { "type": "string", "description": "Optional vendor/extensible subtype when the base role is not enough" } } } }, "chambers": { "type": "array", "items": { "type": "object", "properties": { "temperature": { "type": "object", "properties": { "read": { "type": "boolean" }, "set": { "type": "boolean" } } }, "ref": { "type": "string", "title": "Logical reference, unique within its array. ASCII, lowercase, deterministic", "description": "Logical reference, unique within its array. ASCII, lowercase, deterministic." }, "label": { "type": "string", "description": "Human-readable display name" }, "kind": { "type": "string", "description": "Optional vendor/extensible subtype when the base role is not enough" } } } }, "axes": { "type": "array", "items": { "type": "object", "properties": { "axis": { "oneOf": [ { "const": "x" }, { "const": "y" }, { "const": "z" } ] }, "move": { "type": "boolean" }, "home": { "type": "boolean" }, "flipped": { "type": "boolean" }, "ref": { "type": "string", "title": "Logical reference, unique within its array. ASCII, lowercase, deterministic", "description": "Logical reference, unique within its array. ASCII, lowercase, deterministic." }, "label": { "type": "string", "description": "Human-readable display name" }, "kind": { "type": "string", "description": "Optional vendor/extensible subtype when the base role is not enough" } } } }, "filaments": { "type": "array", "items": { "type": "object", "properties": { "canReadFilament": { "type": "boolean", "title": "True if printer hardware can read filament info from this source", "description": "True if printer hardware can read filament info from this source." }, "canLoad": { "type": "boolean", "title": "True if printer can auto-load filament into this source", "description": "True if printer can auto-load filament into this source." }, "canUnload": { "type": "boolean", "title": "True if printer can auto-unload filament", "description": "True if printer can auto-unload filament." }, "ref": { "type": "string", "title": "Logical reference, unique within its array. ASCII, lowercase, deterministic", "description": "Logical reference, unique within its array. ASCII, lowercase, deterministic." }, "label": { "type": "string", "description": "Human-readable display name" }, "kind": { "type": "string", "description": "Optional vendor/extensible subtype when the base role is not enough" } } }, "description": "Directly-fed filament sources. An array because some printers feed\nmultiple positions simultaneously (Bambu external bay = 2, Snapmaker\nU1 = 4, Bambu H2D = 2+). Each entry is one loadable position.\nAMS / MMU / ERCF / CFS / toolchanger live separately under\n`peripherals` and are presented alongside these in the UI's\nFilaments view." }, "cameras": { "type": "array", "items": { "type": "object", "properties": { "protocol": { "oneOf": [ { "const": "mjpeg-bambu" }, { "const": "rtsps-bambu" }, { "const": "webrtc" }, { "const": "rtsp" }, { "const": "rtsps" }, { "const": "mjpeg-http" }, { "const": "http-snapshot" }, { "const": "http-snapshot-poll" } ] }, "mounting": { "oneOf": [ { "const": "builtin" }, { "const": "external" } ], "title": "`builtin`: seeded by the capability set, locked in the UI", "description": "`builtin`: seeded by the capability set, locked in the UI.\n`external`: user-attached; editable + removable via printer config." }, "url": { "type": "string", "description": "Literal stream URL. Required for non-Bambu protocols, EXCEPT for\n`mjpeg-http` cameras whose endpoint can be synthesized from\n`printer.ip + port` (path-agnostic MJPEG, e.g. Elegoo Centauri\nCarbon 2 on `:8080`). Set `url` when the camera is at a third-party\nabsolute address; otherwise just set `port` and let the go2rtc\ngenerator build `http://${printer.ip}:${port}/`." }, "port": { "type": "number", "title": "Override default port for the protocol", "description": "Override default port for the protocol." }, "path": { "type": "string", "description": "Override the URL path for `mjpeg-http` (default `/`). Used when the\nstream sits behind a fixed path on the printer's web server — e.g.\nMainsail/Fluidd-style `/webcam/?action=stream` for camera-streamer\nor mjpg-streamer. Combined with `printer.ip + port` to build the\nfull URL when `url` isn't set." }, "auth": { "type": "string", "description": "Auth credentials for the stream — `Bearer ...`, `user:pass`, or a\nquery-string fragment. Bambu protocols ignore this; their auth is\nderived from `printer.accessCode`." }, "role": { "oneOf": [ { "const": "overhead" }, { "const": "chamber" }, { "const": "bed" }, { "const": "toolhead" }, { "type": "object", "properties": { "length": { "type": "number", "title": "Returns the length of a String object", "description": "Returns the length of a String object." } }, "additionalProperties": { "type": "string" } } ], "title": "UX-only role for grouping/labeling", "description": "UX-only role for grouping/labeling." }, "snapshots": { "type": "boolean", "title": "Whether to capture periodic snapshots. Defaults true if unset", "description": "Whether to capture periodic snapshots. Defaults true if unset." }, "timelapse": { "type": "boolean", "title": "Whether to record timelapses. Defaults true if unset", "description": "Whether to record timelapses. Defaults true if unset." }, "primary": { "type": "boolean", "description": "When true, this is the printer's primary camera: it owns the bare\n`printer.id` go2rtc stream key, so the live dashboard/printer tile,\nperiodic snapshots, the print-completion thumbnail, and timelapses\nall read from it instead of the built-in camera. At most one camera\nper printer should set this; when none do, the first camera\n(index 0, normally the built-in) is the implicit primary." }, "webrtcSignaling": { "type": "object", "properties": { "flavor": { "oneOf": [ { "const": "whep" }, { "const": "creality-base64-json" }, { "const": "go2rtc-ws" } ] }, "path": { "type": "string", "title": "Endpoint path or full URL for the signaling request", "description": "Endpoint path or full URL for the signaling request." } }, "description": "SDP-exchange config for `protocol: 'webrtc'`. Required when protocol\nis `'webrtc'`; ignored otherwise. The transport itself is always\nstandard WebRTC; this only describes how the offer/answer get traded.\n\nFor `creality-base64-json`, the signaling URL is built from\n`printer.ip:port` + `path` (e.g. http://192.168.1.26:8000/call/webrtc_local).\nFor `whep`, `path` may be a full URL or a path appended to the camera's\nbase URL." }, "ref": { "type": "string", "title": "Logical reference, unique within its array. ASCII, lowercase, deterministic", "description": "Logical reference, unique within its array. ASCII, lowercase, deterministic." }, "label": { "type": "string", "description": "Human-readable display name" }, "kind": { "type": "string", "description": "Optional vendor/extensible subtype when the base role is not enough" } } }, "description": "Cameras attached to the printer. Built-in (`mounting:'builtin'`)\ncameras come from the printer's capability set; external IP/RTSP\ncameras (`mounting:'external'`) are added via printer config.\n\nReplaces the legacy `getCameraProtocol(modelCode)` lookup — all\ncamera config flows through this array." }, "peripherals": { "type": "array", "items": { "type": "object", "properties": { "type": { "oneOf": [ { "const": "ercf" }, { "const": "mmu" }, { "const": "toolchanger" }, { "const": "ams" }, { "type": "object", "properties": { "length": { "type": "number", "title": "Returns the length of a String object", "description": "Returns the length of a String object." } }, "additionalProperties": { "type": "string" } } ] }, "maxUnits": { "type": "number" }, "slotsPerUnit": { "type": "number" }, "minSlotsPerUnit": { "type": "number" }, "maxSlotsPerUnit": { "type": "number" }, "canReadFilament": { "type": "boolean" }, "canLoad": { "type": "boolean" }, "canUnload": { "type": "boolean" }, "ref": { "type": "string", "title": "Logical reference, unique within its array. ASCII, lowercase, deterministic", "description": "Logical reference, unique within its array. ASCII, lowercase, deterministic." }, "label": { "type": "string", "description": "Human-readable display name" }, "kind": { "type": "string", "description": "Optional vendor/extensible subtype when the base role is not enough" } } } }, "printing": { "type": "object", "properties": { "start": { "type": "boolean" }, "pause": { "type": "boolean" }, "resume": { "type": "boolean" }, "stop": { "type": "boolean" }, "skipObjects": { "type": "boolean" } } }, "filament": { "type": "object", "properties": { "setInfo": { "type": "boolean" }, "read": { "type": "boolean" }, "dynamicSlots": { "type": "boolean" } } }, "files": { "type": "object", "properties": { "upload": { "type": "boolean" }, "list": { "type": "boolean" } } }, "gcode": { "type": "boolean" }, "printOptions": { "type": "array", "items": { "type": "object", "properties": { "kind": { "oneOf": [ { "const": "boolean" }, { "const": "enum" } ] }, "default": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ], "title": "UI default when the stored providerConfig is null / missing the key", "description": "UI default when the stored providerConfig is null / missing the key." }, "choices": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "label": { "type": "string" } } }, "title": "For `kind: \"enum\"`: allowed values with display labels", "description": "For `kind: \"enum\"`: allowed values with display labels." }, "description": { "type": "string", "title": "Tooltip help text rendered next to the label", "description": "Tooltip help text rendered next to the label." }, "ref": { "type": "string", "title": "Logical reference, unique within its array. ASCII, lowercase, deterministic", "description": "Logical reference, unique within its array. ASCII, lowercase, deterministic." }, "label": { "type": "string", "description": "Human-readable display name" } } } } } } ] } } } } } } }, "/v1/printers/capabilities/resolve": { "post": { "summary": "Resolve capabilities for printers", "description": "Resolve effective capabilities for multiple printers (bulk).", "tags": [ "Printers" ], "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResolvePrinterCapabilitiesRequest" } } }, "required": true }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResolvePrinterCapabilitiesResponse" } } } } } } }, "/v1/printers/multi": { "patch": { "summary": "Multi-update printers", "description": "Update different fields on each printer in a single request", "tags": [ "Printers" ], "parameters": [], "requestBody": { "description": "Array of individual printer updates", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PartialPrinterUpdateidstring" } } } }, "required": true }, "responses": { "200": { "description": "", "content": { "application/json": {} } } }, "x-permission": "printer.edit" } }, "/v1/printers/{id}/rename": { "patch": { "summary": "Rename a printer", "description": "Change a printer's display name", "tags": [ "Printers" ], "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true, "description": " The printer's unique identifier" } ], "requestBody": { "description": "New name for the printer", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RenamePrinterOptions" } } }, "required": true }, "responses": { "200": { "description": "The renamed printer", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Printer" } } } } }, "x-permission": "printer.edit" } }, "/v1/linked-parts": { "get": { "summary": "Get all linked parts for a store", "tags": [ "Linked_Parts" ], "operationId": "linkedParts_getAll", "parameters": [ { "name": "skuId", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "partId", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "parameters", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "quantity", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "label", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "exposedParameters", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "materialAssignments", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "extensions", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "parameterBindings", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "plateQuantitiesBinding", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "id", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "storeId", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "createdAt", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "updatedAt", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "sort", "in": "query", "schema": { "type": "string" }, "required": false, "title": "Sort" }, { "name": "limit", "in": "query", "schema": { "type": "number", "minimum": 1, "maximum": 1000 }, "required": false, "title": "Limit" }, { "name": "offset", "in": "query", "schema": { "type": "number", "minimum": 0 }, "required": false, "title": "Offset" }, { "name": "fields", "in": "query", "schema": { "type": "string" }, "required": false, "title": "Fields" }, { "name": "include", "in": "query", "schema": { "type": "string" }, "required": false, "title": "Include" }, { "name": "meta", "in": "query", "schema": { "type": "boolean" }, "required": false, "title": "Meta" }, { "name": "hints", "in": "query", "schema": { "type": "boolean" }, "required": false, "title": "Hints" } ], "responses": { "200": { "description": "List of linked parts", "content": { "application/json": { "schema": { "oneOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/LinkedPart" } }, { "$ref": "#/components/schemas/SearchResponse" } ] } } } } }, "x-permission": "sku.view" }, "post": { "summary": "Create a new linked part", "tags": [ "Linked_Parts" ], "parameters": [], "requestBody": { "description": "- Linked part data", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LinkedPartInsert" } } }, "required": true }, "responses": { "201": { "description": "Created linked part", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LinkedPart" } } } } }, "x-permission": "sku.edit" } }, "/v1/linked-parts/search": { "post": { "summary": "Search linked parts", "description": "Advanced search for linked parts", "tags": [ "Linked_Parts" ], "operationId": "linkedParts_search", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchQueryDtoLinkedPart" } } }, "required": true }, "responses": { "201": { "description": "Search results with linked parts", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchResponse" } } } } }, "x-permission": "sku.view" } }, "/v1/linked-parts/{id}": { "get": { "summary": "Get a specific linked part by ID", "tags": [ "Linked_Parts" ], "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true, "description": " - Linked part identifier" } ], "responses": { "200": { "description": "Linked part details", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LinkedPart" } } } } }, "x-permission": "sku.view" }, "patch": { "summary": "Update a linked part", "tags": [ "Linked_Parts" ], "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true, "description": " - Linked part identifier" } ], "requestBody": { "description": "- Updated linked part data", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartialLinkedPartInsert" } } }, "required": true }, "responses": { "200": { "description": "Updated linked part", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LinkedPart" } } } } }, "x-permission": "sku.edit" }, "delete": { "summary": "Delete a linked part", "tags": [ "Linked_Parts" ], "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true, "description": " - Linked part identifier" } ], "responses": { "200": { "description": "Array of deleted linked part IDs", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } } }, "x-permission": "sku.edit" } }, "/v1/profiles": { "get": { "summary": "Get all slicer profiles", "tags": [ "Profiles" ], "parameters": [ { "name": "id", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "name", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "type", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "externalId", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "source", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "inherits", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "compatibilityList", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "data", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "metadata", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "integrationId", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "integrationType", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "storeId", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "updatedAt", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "createdAt", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "sort", "in": "query", "schema": { "type": "string" }, "required": false, "title": "Sort" }, { "name": "limit", "in": "query", "schema": { "type": "number", "minimum": 1, "maximum": 1000 }, "required": false, "title": "Limit" }, { "name": "offset", "in": "query", "schema": { "type": "number", "minimum": 0 }, "required": false, "title": "Offset" }, { "name": "fields", "in": "query", "schema": { "type": "string" }, "required": false, "title": "Fields" }, { "name": "include", "in": "query", "schema": { "type": "string" }, "required": false, "title": "Include" }, { "name": "meta", "in": "query", "schema": { "type": "boolean" }, "required": false, "title": "Meta" }, { "name": "hints", "in": "query", "schema": { "type": "boolean" }, "required": false, "title": "Hints" } ], "responses": { "200": { "description": "List of all slicer profiles in the store", "content": { "application/json": { "schema": { "oneOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/Profile" } }, { "$ref": "#/components/schemas/SearchResponse" } ] } } } } }, "x-permission": "profile.view" }, "post": { "summary": "Create a new profile", "tags": [ "Profiles" ], "parameters": [], "requestBody": { "description": "- Profile data", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProfileInsert" } } }, "required": true }, "responses": { "201": { "description": "The created profile", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Profile" } } } } }, "x-permission": "profile.create" }, "delete": { "summary": "Delete multiple profiles", "tags": [ "Profiles" ], "parameters": [], "requestBody": { "description": "- Array of profile IDs to delete", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string", "pattern": "^[a-z0-9]{24}$" } } } }, "required": true }, "responses": { "200": { "description": "IDs of deleted profiles", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string", "pattern": "^[a-z0-9]{24}$" } } } } } }, "x-permission": "profile.delete" } }, "/v1/profiles/search": { "post": { "summary": "Search profiles", "description": "Search profiles with complex filters", "tags": [ "Profiles" ], "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchQueryDtoProfile" } } }, "required": true }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchResponse" } } } } }, "x-permission": "profile.view" } }, "/v1/profiles/supported": { "get": { "summary": "Get supported printer models", "tags": [ "Profiles" ], "parameters": [], "responses": { "200": { "description": "List of printer models with supported features", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SupportedPrinter" } } } } } }, "x-permission": "profile.view" } }, "/v1/profiles/printer-models": { "get": { "summary": "Get all available printer models", "tags": [ "Profiles" ], "parameters": [], "responses": { "200": { "description": "Complete list of all printer models in the system", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PrinterModel" } } } } } }, "x-permission": "profile.view" } }, "/v1/profiles/my-printer-models": { "get": { "summary": "Get printer models used in your store", "tags": [ "Profiles" ], "parameters": [], "responses": { "200": { "description": "List of printer models that have profiles in your store", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PrinterModel" } } } } } }, "x-permission": "profile.view" } }, "/v1/profiles/slicer-versions": { "get": { "summary": "Get available slicer versions", "tags": [ "Profiles" ], "parameters": [], "responses": { "200": { "description": "List of synced slicer versions with their patch levels and slicer engine", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "version": { "type": "string" }, "patch": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "slicer": { "oneOf": [ { "const": "orcaslicer" }, { "const": "bambu-studio" }, { "const": "prusaslicer" }, { "const": "superslicer" } ] } }, "required": [ "version", "patch", "slicer" ] } } } } } }, "x-permission": "settings.view" } }, "/v1/profiles/{id}/full": { "get": { "summary": "Get full profile data with optional slicer version", "tags": [ "Profiles" ], "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "version", "in": "query", "schema": { "type": "string" }, "required": false } ], "responses": { "200": { "description": "Full profile data with inheritance resolved", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Recordstringany" } } } } }, "x-permission": "profile.view" } }, "/v1/profiles/{id}": { "get": { "summary": "Get a specific profile", "tags": [ "Profiles" ], "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true, "description": " - The profile ID" } ], "responses": { "200": { "description": "The requested slicer profile", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Profile" } } } } }, "x-permission": "profile.view" }, "patch": { "summary": "Update a profile", "tags": [ "Profiles" ], "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true, "description": " - The profile ID" } ], "requestBody": { "description": "- Profile update data", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProfileUpdateDto" } } }, "required": true }, "responses": { "200": { "description": "The updated profile", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Profile" } } } } }, "x-permission": "profile.edit" }, "delete": { "summary": "Delete a profile", "tags": [ "Profiles" ], "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true, "description": " - The profile ID to delete" } ], "responses": { "200": { "description": "Array containing the deleted profile ID", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } } }, "x-permission": "profile.delete" } }, "/v1/profiles/compatible/{id}": { "get": { "summary": "Get profiles compatible with a printer", "tags": [ "Profiles" ], "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true } ], "responses": { "200": { "description": "Profiles compatible with the specified printer", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompatibleProfiles" } } } } }, "x-permission": "profile.view" } }, "/v1/profiles/compatible/{machineModel}/{nozzleDiameter}": { "get": { "summary": "Get profiles by machine model and nozzle size", "tags": [ "Profiles" ], "parameters": [ { "name": "machineModel", "in": "path", "schema": { "type": "string" }, "required": true, "description": " - The printer model name" }, { "name": "nozzleDiameter", "in": "path", "schema": { "type": "string" }, "required": true, "description": " - The nozzle diameter (e.g., \"0.4\")" } ], "responses": { "200": { "description": "Profiles matching the specified criteria", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompatibleProfiles" } } } } }, "x-permission": "profile.view" } }, "/v1/profiles/{id}/view": { "get": { "summary": "Get profile with inheritance details", "tags": [ "Profiles" ], "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true, "description": " - The profile ID" }, { "name": "version", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "slicerEngine", "in": "query", "schema": { "oneOf": [ { "const": "orcaslicer" }, { "const": "bambu-studio" }, { "const": "prusaslicer" }, { "const": "superslicer" } ] }, "required": false } ], "responses": { "200": { "description": "Profile data with inheritance information", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProfileWithInheritance" } } } } }, "x-permission": "profile.view" } }, "/v1/profiles/{id}/versions": { "get": { "summary": "Get available slicer versions for a profile", "tags": [ "Profiles" ], "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true, "description": " - The profile ID" } ], "responses": { "200": { "description": "List of slicer versions that have the profile's inherited parent", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "version": { "type": "string" }, "patch": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "slicer": { "oneOf": [ { "const": "orcaslicer" }, { "const": "bambu-studio" }, { "const": "prusaslicer" }, { "const": "superslicer" } ] } }, "required": [ "version", "patch", "slicer" ] } } } } } }, "x-permission": "profile.view" } }, "/v1/profiles/preview": { "post": { "summary": "Preview profiles from a file", "tags": [ "Profiles" ], "parameters": [], "requestBody": { "description": "- File containing profiles to preview", "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ProfileUploadBody" } } }, "required": true }, "responses": { "201": { "description": "Preview of profiles found in the file", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProfilePreviewResult" } } } } }, "x-permission": "profile.create" } }, "/v1/profiles/import": { "post": { "summary": "Import profiles from a file", "tags": [ "Profiles" ], "parameters": [], "requestBody": { "description": "- File and import options", "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ProfileImportBody" } } }, "required": true }, "responses": { "201": { "description": "Results of the import operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProfileImportResult" } } } } }, "x-permission": "profile.create" } }, "/v1/profiles/import-data": { "post": { "summary": "Import pre-parsed profiles", "tags": [ "Profiles" ], "parameters": [], "requestBody": { "description": "- Pre-parsed profile data and import options", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProfileImportDataBody" } } }, "required": true }, "responses": { "201": { "description": "Results of the import operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProfileImportResult" } } } } }, "x-permission": "profile.create" } }, "/v1/print-jobs": { "get": { "summary": "Get all print jobs", "description": "List all print jobs including queued, printing, and completed jobs", "tags": [ "Print_Jobs" ], "parameters": [ { "name": "partBuildId", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "quantityIndex", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "quantityTotal", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "thumbnailUri", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "coloredThumbnailUri", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "buildThumbnailUri", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "cameraThumbnailUri", "in": "query", "schema": { "type": "string" }, "required": false, "description": "Camera-captured snapshot from the moment Fuse detected the last\nlayer of the print. Persisted to the files bucket. Null unless Fuse\nsuccessfully captured and uploaded." }, { "name": "timelapseUri", "in": "query", "schema": { "type": "string" }, "required": false, "description": "MP4 timelapse Fuse encoded from frames captured during the print and\nuploaded to the snapshots bucket under the `timelapses/` prefix.\nNull unless the store has timelapses enabled and Fuse uploaded\nsuccessfully." }, { "name": "filesToPrint", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "slicerInputHash", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "isGcodeCached", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "slicedGcodeUri", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "partId", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "partName", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "skuId", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "skuName", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "parameterOverrides", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "orderId", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "label", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "orderItemId", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "linkedPartId", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "skuInstance", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "queueOrder", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "priority", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "requiredPrinterTags", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "overriddenProcessProfileId", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "taskId", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "profileUris", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "assignedPrinterId", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "assignmentStartedAt", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "assignmentCompletedAt", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "printingStartedAt", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "printingCompletedAt", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "cancelledAt", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "status", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "errorMessage", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "hidden", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "logsUri", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "extensions", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "skipObjectsData", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "skipObjectIds", "in": "query", "schema": { "type": "string" }, "required": false, "description": "User-selected objects to skip on this job's plate, as identifyId strings\n(resolved at queue time from the part's plate object list). When the print\nstarts, a Bambu `skip_objects` command is auto-sent for these. Null/empty\nmeans print everything. Stored as strings; converted to integer obj_list at\nsend time." }, { "name": "materialMapping", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "materialAssignments", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "gcodeAnalysisSha256", "in": "query", "schema": { "type": "string" }, "required": false, "description": "SHA256 hash of analyzed gcode content — stable key for extrusion lookup" }, { "name": "groupId", "in": "query", "schema": { "type": "string" }, "required": false, "description": "Group identifier for visually-collapsed print-queue rows. Assigned at\nemission (one per plate cluster within a build). Split mints fresh\ngroupIds for non-first buckets. May be null for legacy rows that predate\nthe grouping feature." }, { "name": "id", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "storeId", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "createdAt", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "updatedAt", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "sort", "in": "query", "schema": { "type": "string" }, "required": false, "title": "Sort" }, { "name": "limit", "in": "query", "schema": { "type": "number", "minimum": 1, "maximum": 1000 }, "required": false, "title": "Limit" }, { "name": "offset", "in": "query", "schema": { "type": "number", "minimum": 0 }, "required": false, "title": "Offset" }, { "name": "fields", "in": "query", "schema": { "type": "string" }, "required": false, "title": "Fields" }, { "name": "include", "in": "query", "schema": { "type": "string" }, "required": false, "title": "Include" }, { "name": "meta", "in": "query", "schema": { "type": "boolean" }, "required": false, "title": "Meta" }, { "name": "hints", "in": "query", "schema": { "type": "boolean" }, "required": false, "title": "Hints" } ], "responses": { "200": { "description": "All print jobs with their current status", "content": { "application/json": { "schema": { "oneOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/PrintJob" } }, { "$ref": "#/components/schemas/SearchResponse" } ] } } } } }, "x-permission": "queue.view" } }, "/v1/print-jobs/search": { "post": { "summary": "Search print jobs", "description": "Search print jobs with complex filters", "tags": [ "Print_Jobs" ], "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchQueryDtoPrintJob" } } }, "required": true }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchResponse" } } } } }, "x-permission": "queue.view" } }, "/v1/print-jobs/stats/completed-count": { "get": { "summary": "Get completed job count", "description": "Get total number of completed print jobs", "tags": [ "Print_Jobs" ], "parameters": [], "responses": { "200": { "description": "Count of completed jobs", "content": { "application/json": { "schema": { "type": "number" } } } } }, "x-permission": "queue.view" } }, "/v1/print-jobs/pause": { "patch": { "summary": "Pause print jobs", "description": "Send printer a command to pause the job", "tags": [ "Print_Jobs" ], "parameters": [], "requestBody": { "description": "IDs of jobs to pause", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrintJobOperationRequest" } } }, "required": true }, "responses": { "200": { "description": "IDs of paused jobs", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string", "pattern": "^[a-z0-9]{24}$" } } } } } }, "x-permission": "queue.manage" } }, "/v1/print-jobs/cancel": { "patch": { "summary": "Cancel print jobs", "description": "Cancel job(s) that are queued or in progress. If in progress (printing), also sends the \nprinter(s) a stop/cancel command.", "tags": [ "Print_Jobs" ], "parameters": [], "requestBody": { "description": "IDs of jobs to cancel", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CancelPrintJobsRequest" } } }, "required": true }, "responses": { "200": { "description": "IDs of cancelled jobs", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string", "pattern": "^[a-z0-9]{24}$" } } } } } }, "x-permission": "queue.manage" } }, "/v1/print-jobs/resume": { "patch": { "summary": "Resume paused jobs", "description": "Send printer a command to resume a paused job", "tags": [ "Print_Jobs" ], "parameters": [], "requestBody": { "description": "IDs of jobs to resume", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrintJobOperationRequest" } } }, "required": true }, "responses": { "200": { "description": "IDs of resumed jobs", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string", "pattern": "^[a-z0-9]{24}$" } } } } } }, "x-permission": "queue.manage" } }, "/v1/print-jobs/retry": { "patch": { "summary": "Retry failed jobs", "description": "Retry cancelled or failed jobs by resetting them to queued status", "tags": [ "Print_Jobs" ], "parameters": [], "requestBody": { "description": "IDs of jobs to retry", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrintJobOperationRequest" } } }, "required": true }, "responses": { "200": { "description": "IDs of jobs reset for retry", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string", "pattern": "^[a-z0-9]{24}$" } } } } } }, "x-permission": "queue.manage" } }, "/v1/print-jobs/archived": { "get": { "summary": "List archived jobs", "description": "List archived (hidden) print jobs with cursor-based pagination", "tags": [ "Print_Jobs" ], "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "cursor", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "orderId", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "orderItemId", "in": "query", "schema": { "type": "string" }, "required": false } ], "responses": { "200": { "description": "Paginated list of archived jobs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ArchivedPrintJobsResponse" } } } } }, "x-permission": "queue.view" } }, "/v1/print-jobs/clear": { "patch": { "summary": "Clear finished jobs", "description": "Archive completed or cancelled jobs, hiding them from the queue and sync", "tags": [ "Print_Jobs" ], "parameters": [], "requestBody": { "description": "IDs of jobs to clear", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrintJobOperationRequest" } } }, "required": true }, "responses": { "200": { "description": "IDs of cleared jobs", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string", "pattern": "^[a-z0-9]{24}$" } } } } } }, "x-permission": "job.delete.all" } }, "/v1/print-jobs/move-to-queue-front": { "patch": { "summary": "Prioritize jobs", "description": "Move jobs to the front of the queue for priority printing", "tags": [ "Print_Jobs" ], "parameters": [], "requestBody": { "description": "IDs of jobs to prioritize", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrintJobOperationRequest" } } }, "required": true }, "responses": { "200": { "description": "IDs of prioritized jobs", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string", "pattern": "^[a-z0-9]{24}$" } } } } } }, "x-permission": "queue.override" } }, "/v1/print-jobs/groups/quantity": { "patch": { "summary": "Adjust group quantity", "description": "Adjust the total quantity of a print-queue group. Clones or trims jobs so\nthe group ends up with exactly `targetQuantity` pending members. Order-\nlinked groups are rejected — use the order flow instead.", "tags": [ "Print_Jobs" ], "parameters": [], "requestBody": { "description": "Group key and new total quantity (1..500)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdjustGroupQuantityRequest" } } }, "required": true }, "responses": { "200": { "description": "The updated group", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdjustGroupQuantityResponse" } } } } }, "x-permission": "queue.manage" } }, "/v1/print-jobs/groups/split": { "post": { "summary": "Split group", "description": "Split a print-queue group into multiple smaller groups while preserving\nqueue order. Bucket 0 keeps the original groupId; each subsequent bucket\nreceives a fresh id.", "tags": [ "Print_Jobs" ], "parameters": [], "requestBody": { "description": "Group key and bucket sizes summing to the group size", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SplitGroupRequest" } } }, "required": true }, "responses": { "201": { "description": "The new groups in queue order", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SplitGroupResponse" } } } } }, "x-permission": "queue.manage" } }, "/v1/print-jobs/groups/reorder": { "patch": { "summary": "Reorder group", "description": "Reorder an entire print-queue group as a contiguous block.", "tags": [ "Print_Jobs" ], "parameters": [], "requestBody": { "description": "Group id and target index in the pending queue", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReorderGroupRequest" } } }, "required": true }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReorderGroupResponse" } } } } }, "x-permission": "queue.manage" } }, "/v1/print-jobs/{id}/matching-details": { "get": { "summary": "Get job matching details", "description": "Get details about why a job is or isn't matching to printers", "tags": [ "Print_Jobs" ], "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true, "description": " The print job ID" } ], "responses": { "200": { "description": "Matching criteria and compatible printers", "content": { "application/json": { "schema": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/PrintJobMatchingDetail" } ] } } } } }, "x-permission": "queue.view" } }, "/v1/print-jobs/{id}/matching-troubleshoot": { "get": { "summary": "Get job matching troubleshooting details", "description": "Get troubleshooting details for why a job is or isn't matching to each printer", "tags": [ "Print_Jobs" ], "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true, "description": " The print job ID" } ], "responses": { "200": { "description": "Detailed checklist of matching criteria for all printers", "content": { "application/json": { "schema": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/PrintJobMatchingTroubleshoot" } ] } } } } }, "x-permission": "queue.view" } }, "/v1/print-jobs/queue/run": { "post": { "summary": "Run the queue matcher now", "description": "Run the queue matcher synchronously, bypassing the per-store\n\"Automatic Queue Matching\" gate. Use this for an explicit \"match the\nqueue right now\" action (e.g. after staging printer/material changes\nwith auto matching turned off). Returns the resulting (printer, job)\npairs so the caller can render them or fold them into a future\ndry-run/preview UI.", "tags": [ "Print_Jobs" ], "parameters": [], "responses": { "201": { "description": "The matcher's outcome: assignments produced or a skip reason", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RunQueueResponse" } } } } }, "x-permission": "queue.manage" } }, "/v1/print-jobs/queue/group-matching": { "post": { "summary": "Get compatible printers per queue group", "description": "Bulk-evaluate the pending print queue and return the list of compatible\nprinters per queue group. The matcher runs once per group (not once per\njob) since every job in a group shares the same part, materials, and\nrequired tags. Used by the queue UI to populate the per-row \"Send to...\"\npicker without firing one troubleshooter call per row.", "tags": [ "Print_Jobs" ], "parameters": [], "requestBody": { "description": "Optional subset of pending print job IDs to consider; defaults to the entire pending queue", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QueueGroupMatchingRequest" } } }, "required": true }, "responses": { "201": { "description": "Per-group printer compatibility, one entry per distinct groupId", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QueueGroupMatchingResponse" } } } } }, "x-permission": "queue.view" } }, "/v1/print-jobs/{id}/send-to-printer": { "post": { "summary": "Send job directly to a printer", "description": "Send a specific pending job directly to a chosen printer, skipping the\nglobal queue matcher. The printer does not need to be marked ready —\nmarking ready re-runs queue matching, which is the side effect this\nendpoint exists to avoid. The atomic printer claim and the standard\ncompatibility checks still apply (bypass with `force=true` at your own\nrisk).", "tags": [ "Print_Jobs" ], "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true, "description": " The print job ID" } ], "requestBody": { "description": "Target printer and optional force flag", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SendPrintJobToPrinterRequest" } } }, "required": true }, "responses": { "201": { "description": "The updated print job in `assigned` status", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SendPrintJobToPrinterResponse" } } } } }, "x-permission": "queue.manage" } }, "/v1/print-jobs/{id}/reorder": { "patch": { "summary": "Reorder a job", "description": "Change a job's position in the print queue", "tags": [ "Print_Jobs" ], "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true, "description": " The print job ID" } ], "requestBody": { "description": "New queue position and priority", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReorderPrintJobRequest" } } }, "required": true }, "responses": { "200": { "description": "", "content": { "application/json": {} } } }, "x-permission": "queue.manage" } }, "/v1/print-jobs/bulk-reorder": { "patch": { "summary": "Bulk reorder jobs", "description": "Reorder multiple jobs at once", "tags": [ "Print_Jobs" ], "parameters": [], "requestBody": { "description": "Array of job IDs with their new positions", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkReorderPrintJobsRequest" } } }, "required": true }, "responses": { "200": { "description": "", "content": { "application/json": {} } } }, "x-permission": "queue.manage" } }, "/v1/print-jobs/{id}": { "get": { "summary": "Get print job", "description": "Get a single print job by ID", "tags": [ "Print_Jobs" ], "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true, "description": " The print job ID" } ], "responses": { "200": { "description": "The print job details", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrintJob" } } } } }, "x-permission": "queue.view" }, "patch": { "summary": "Update print job", "description": "Update a print job's properties", "tags": [ "Print_Jobs" ], "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true, "description": " The print job ID" } ], "requestBody": { "description": "Fields to update", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartialPrintJobInsert" } } }, "required": true }, "responses": { "200": { "description": "The updated print job", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrintJob" } } } } }, "x-permission": "job.edit.all" } }, "/v1/stores": { "get": { "summary": "Get all stores for current user", "tags": [ "Stores" ], "parameters": [], "responses": { "200": { "description": "List of stores accessible to the user", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Store" } } } } } } }, "patch": { "summary": "Update organization settings", "tags": [ "Stores" ], "parameters": [], "requestBody": { "description": "The fields to update", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StoreUpdate" } } }, "required": true }, "responses": { "200": { "description": "Updated store", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Store" } } } } }, "x-permission": "organization.edit" } }, "/v1/skus": { "get": { "summary": "List all SKUs", "tags": [ "SKUs" ], "parameters": [ { "name": "sku", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "title", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "description", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "externalId", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "externalProvider", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "folderId", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "totalCogs", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "id", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "storeId", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "createdAt", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "updatedAt", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "sort", "in": "query", "schema": { "type": "string" }, "required": false, "title": "Sort" }, { "name": "limit", "in": "query", "schema": { "type": "number", "minimum": 1, "maximum": 1000 }, "required": false, "title": "Limit" }, { "name": "offset", "in": "query", "schema": { "type": "number", "minimum": 0 }, "required": false, "title": "Offset" }, { "name": "fields", "in": "query", "schema": { "type": "string" }, "required": false, "title": "Fields" }, { "name": "include", "in": "query", "schema": { "type": "string" }, "required": false, "title": "Include" }, { "name": "meta", "in": "query", "schema": { "type": "boolean" }, "required": false, "title": "Meta" }, { "name": "hints", "in": "query", "schema": { "type": "boolean" }, "required": false, "title": "Hints" } ], "responses": { "200": { "description": "Array of all SKUs in the store with their linked parts", "content": { "application/json": { "schema": { "oneOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/SkuLinkedPartsRelation" } }, { "$ref": "#/components/schemas/SearchResponse" } ] } } } } }, "x-permission": "sku.view" }, "post": { "summary": "Create a new SKU", "tags": [ "SKUs" ], "parameters": [], "requestBody": { "description": "The SKU data including name, price, and linked parts", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SkuInsert" } } }, "required": true }, "responses": { "201": { "description": "The newly created SKU with its relations", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SkuLinkedPartsRelation" } } } } }, "x-permission": "sku.create" } }, "/v1/skus/search": { "post": { "summary": "Search SKUs", "description": "Search SKUs with complex filters", "tags": [ "SKUs" ], "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchQueryDtoSku" } } }, "required": true }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchResponse" } } } } }, "x-permission": "sku.view" } }, "/v1/skus/{id}": { "get": { "summary": "Get a specific SKU", "tags": [ "SKUs" ], "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true, "description": " The unique identifier of the SKU" } ], "responses": { "200": { "description": "The SKU with its linked parts and part details", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SkuLinkedPartsWithPartRelation" } } } } }, "x-permission": "sku.view" }, "patch": { "summary": "Update a SKU", "tags": [ "SKUs" ], "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true, "description": " The unique identifier of the SKU to update" } ], "requestBody": { "description": "The partial SKU data to update", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartialSkuInsert" } } }, "required": true }, "responses": { "200": { "description": "The updated SKU", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Sku" } } } } }, "x-permission": "sku.edit" }, "delete": { "summary": "Delete a SKU", "tags": [ "SKUs" ], "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true, "description": " The unique identifier of the SKU to delete" } ], "responses": { "200": { "description": "Success confirmation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } } }, "x-permission": "sku.delete" } }, "/v1/skus/delete-many": { "post": { "summary": "Delete multiple SKUs", "tags": [ "SKUs" ], "parameters": [], "requestBody": { "description": "Array of SKU identifiers to delete", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string", "pattern": "^[a-z0-9]{24}$" } } } }, "required": true }, "responses": { "201": { "description": "Array of successfully deleted SKU identifiers", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string", "pattern": "^[a-z0-9]{24}$" } } } } } }, "x-permission": "sku.delete" } }, "/v2/builds": { "post": { "summary": "Create and queue prints", "description": "Create prints containing parts and/or SKUs.\n\nYou can issue prints by specifying individual parts and/or complete SKUs (products).\nEach part or SKU can be customized with specific quantities, parameters, materials, and other configuration options.", "tags": [ "Printing" ], "parameters": [], "requestBody": { "description": "- Build configuration specifying parts and SKUs to include", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BuildConfigV2" } } }, "required": true }, "responses": { "201": { "description": "Result containing created part builds and SKU builds with their assigned IDs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BuildResultV2" } } } } } } }, "/v2/builds/preview": { "post": { "summary": "Preview part builds and jobs (dry run)", "description": "Preview builds and jobs that would be created without queueing anything.", "tags": [ "Printing" ], "parameters": [], "requestBody": { "description": "- Build configuration specifying parts and SKUs to preview", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BuildConfigV2" } } }, "required": true }, "responses": { "201": { "description": "Preview of part builds and jobs grouped by part build", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BuildPreviewV2" } } } } } } }, "/v1/part-builds": { "get": { "summary": "Get all part builds for a store", "tags": [ "Part_Builds" ], "parameters": [ { "name": "partId", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "skuBuildId", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "skuId", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "skuName", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "label", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "partCopy", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "requiredPrinterTags", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "quantity", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "numPartsPerSku", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "skuInstanceStart", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "parameterOverrides", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "status", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "outputFiles", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "thumbnailUri", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "assignmentStartedAt", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "assignmentCompletedAt", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "printingStartedAt", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "printingCompletedAt", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "printStatus", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "extensions", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "materialAssignments", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "priority", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "position", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "orderId", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "orderItemId", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "linkedPartId", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "dismissed", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "id", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "storeId", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "createdAt", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "updatedAt", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "sort", "in": "query", "schema": { "type": "string" }, "required": false, "title": "Sort" }, { "name": "limit", "in": "query", "schema": { "type": "number", "minimum": 1, "maximum": 1000 }, "required": false, "title": "Limit" }, { "name": "offset", "in": "query", "schema": { "type": "number", "minimum": 0 }, "required": false, "title": "Offset" }, { "name": "fields", "in": "query", "schema": { "type": "string" }, "required": false, "title": "Fields" }, { "name": "include", "in": "query", "schema": { "type": "string" }, "required": false, "title": "Include" }, { "name": "meta", "in": "query", "schema": { "type": "boolean" }, "required": false, "title": "Meta" }, { "name": "hints", "in": "query", "schema": { "type": "boolean" }, "required": false, "title": "Hints" } ], "responses": { "200": { "description": "List of part builds with their steps and print jobs", "content": { "application/json": { "schema": { "oneOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/PartBuildWithRelation" } }, { "$ref": "#/components/schemas/SearchResponse" } ] } } } } }, "x-permission": "queue.view" } }, "/v1/part-builds/search": { "post": { "summary": "Search part builds", "description": "Search part builds with complex filters", "tags": [ "Part_Builds" ], "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchQueryDtoPartBuild" } } }, "required": true }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchResponse" } } } } }, "x-permission": "queue.view" } }, "/v1/part-builds/{id}": { "get": { "summary": "Get a specific part build by ID", "tags": [ "Part_Builds" ], "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true, "description": " - Part build identifier" } ], "responses": { "200": { "description": "Part build details with steps and print jobs, or undefined if not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartBuildWithRelation" } } } } }, "x-permission": "queue.view" } }, "/v1/part-builds/archive": { "patch": { "summary": "Archive part builds", "description": "Archive part builds, hiding them from the queue and sync", "tags": [ "Part_Builds" ], "parameters": [], "requestBody": { "description": "- Request containing part build IDs to archive", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartBuildOperationRequest" } } }, "required": true }, "responses": { "200": { "description": "List of archived part build IDs", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string", "pattern": "^[a-z0-9]{24}$" } } } } } }, "x-permission": "queue.manage" } }, "/v1/part-builds/restore": { "patch": { "summary": "Restore archived part builds", "description": "Restore archived part builds back to the queue", "tags": [ "Part_Builds" ], "parameters": [], "requestBody": { "description": "- Request containing part build IDs to restore", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartBuildOperationRequest" } } }, "required": true }, "responses": { "200": { "description": "List of restored part build IDs", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string", "pattern": "^[a-z0-9]{24}$" } } } } } }, "x-permission": "queue.manage" } }, "/v1/part-builds/dismiss": { "patch": { "summary": "Dismiss part builds (deprecated)", "deprecated": true, "tags": [ "Part_Builds" ], "parameters": [], "requestBody": { "description": "- Request containing part build IDs to dismiss", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartBuildOperationRequest" } } }, "required": true }, "responses": { "200": { "description": "List of dismissed part build IDs", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string", "pattern": "^[a-z0-9]{24}$" } } } } } }, "x-permission": "queue.manage" } }, "/v1/users": { "get": { "tags": [ "Users" ], "parameters": [ { "name": "search", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "role", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "status", "in": "query", "schema": { "oneOf": [ { "const": "active" }, { "const": "inactive" } ] }, "required": false }, { "name": "limit", "in": "query", "schema": { "type": "number" }, "required": false }, { "name": "offset", "in": "query", "schema": { "type": "number" }, "required": false } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetUsersResponse" } } } } } } }, "/v1/users/{userId}": { "get": { "tags": [ "Users" ], "parameters": [ { "name": "userId", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserDetails" } } } } } }, "delete": { "tags": [ "Users" ], "parameters": [ { "name": "userId", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RemoveUserRequest" } } }, "required": true }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } }, "required": [ "success", "message" ] } } } } } } }, "/v1/users/invite": { "post": { "tags": [ "Users" ], "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InviteUserRequest" } } }, "required": true }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InviteUserResponse" } } } } } } }, "/v1/users/invite/{invitationId}/resend": { "post": { "tags": [ "Users" ], "parameters": [ { "name": "invitationId", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" } }, "required": [ "success" ] } } } } } } }, "/v1/users/invite/{invitationId}/revoke": { "post": { "tags": [ "Users" ], "parameters": [ { "name": "invitationId", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" } }, "required": [ "success" ] } } } } } } }, "/v1/users/{userId}/roles": { "post": { "tags": [ "Users" ], "parameters": [ { "name": "userId", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "roleId": { "type": "string" } }, "required": [ "roleId" ] } } }, "required": true }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserDetails" } } } } } }, "put": { "tags": [ "Users" ], "parameters": [ { "name": "userId", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "roleIds": { "type": "array", "items": { "type": "string" } } }, "required": [ "roleIds" ] } } }, "required": true }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserDetails" } } } } } } }, "/v1/users/{userId}/roles/{roleId}": { "delete": { "tags": [ "Users" ], "parameters": [ { "name": "userId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "roleId", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserDetails" } } } } } } }, "/v1/users/{userId}/permissions": { "post": { "tags": [ "Users" ], "parameters": [ { "name": "userId", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "permissions": { "type": "array", "items": { "oneOf": [ { "const": "organization.owner" }, { "const": "organization.edit" }, { "const": "organization.delete" }, { "const": "user.view" }, { "const": "user.invite" }, { "const": "user.edit" }, { "const": "user.delete" }, { "const": "permission.view" }, { "const": "permission.grant" }, { "const": "permission.revoke" }, { "const": "part.view" }, { "const": "part.create" }, { "const": "part.edit" }, { "const": "part.delete" }, { "const": "part.export" }, { "const": "sku.view" }, { "const": "sku.create" }, { "const": "sku.edit" }, { "const": "sku.delete" }, { "const": "material.view" }, { "const": "material.create" }, { "const": "material.edit" }, { "const": "material.delete" }, { "const": "material.instance.view" }, { "const": "material.instance.create" }, { "const": "material.instance.edit" }, { "const": "material.instance.delete" }, { "const": "printer.view" }, { "const": "printer.create" }, { "const": "printer.edit" }, { "const": "printer.delete" }, { "const": "printer.control" }, { "const": "printer.ready" }, { "const": "printer.config" }, { "const": "printer.stats" }, { "const": "printer.camera" }, { "const": "profile.view" }, { "const": "profile.create" }, { "const": "profile.edit" }, { "const": "profile.delete" }, { "const": "queue.view" }, { "const": "queue.manage" }, { "const": "queue.override" }, { "const": "job.create" }, { "const": "job.edit.own" }, { "const": "job.edit.all" }, { "const": "job.delete.own" }, { "const": "job.delete.all" }, { "const": "build.view" }, { "const": "build.create" }, { "const": "build.edit" }, { "const": "build.delete" }, { "const": "settings.view" }, { "const": "settings.edit" }, { "const": "integration.view" }, { "const": "integration.manage" }, { "const": "subscription.view" }, { "const": "subscription.manage" }, { "const": "analytics.view" }, { "const": "reports.generate" }, { "const": "audit.log.view" }, { "const": "audit.logs.configure" }, { "const": "order.view" }, { "const": "order.create" }, { "const": "order.edit" }, { "const": "order.delete" }, { "const": "order.print" }, { "const": "apiKey.view" }, { "const": "apiKey.create" }, { "const": "apiKey.edit" }, { "const": "apiKey.delete" }, { "const": "file.download" }, { "const": "maintenance.view" }, { "const": "maintenance.create" }, { "const": "maintenance.edit" }, { "const": "maintenance.delete" }, { "const": "maintenance.complete" }, { "const": "internal.shopify" }, { "const": "queue.admin" }, { "const": "part.viewer" }, { "const": "part.editor" }, { "const": "sku.viewer" }, { "const": "sku.editor" }, { "const": "orders.admin" }, { "const": "material.viewer" }, { "const": "material.editor" }, { "const": "printer.viewer" }, { "const": "printer.editor" }, { "const": "profile.viewer" }, { "const": "profile.editor" }, { "const": "settings.admin" }, { "const": "subscription.admin" } ] } } }, "required": [ "permissions" ] } } }, "required": true }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserDetails" } } } } } }, "delete": { "tags": [ "Users" ], "parameters": [ { "name": "userId", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "permissions": { "type": "array", "items": { "oneOf": [ { "const": "organization.owner" }, { "const": "organization.edit" }, { "const": "organization.delete" }, { "const": "user.view" }, { "const": "user.invite" }, { "const": "user.edit" }, { "const": "user.delete" }, { "const": "permission.view" }, { "const": "permission.grant" }, { "const": "permission.revoke" }, { "const": "part.view" }, { "const": "part.create" }, { "const": "part.edit" }, { "const": "part.delete" }, { "const": "part.export" }, { "const": "sku.view" }, { "const": "sku.create" }, { "const": "sku.edit" }, { "const": "sku.delete" }, { "const": "material.view" }, { "const": "material.create" }, { "const": "material.edit" }, { "const": "material.delete" }, { "const": "material.instance.view" }, { "const": "material.instance.create" }, { "const": "material.instance.edit" }, { "const": "material.instance.delete" }, { "const": "printer.view" }, { "const": "printer.create" }, { "const": "printer.edit" }, { "const": "printer.delete" }, { "const": "printer.control" }, { "const": "printer.ready" }, { "const": "printer.config" }, { "const": "printer.stats" }, { "const": "printer.camera" }, { "const": "profile.view" }, { "const": "profile.create" }, { "const": "profile.edit" }, { "const": "profile.delete" }, { "const": "queue.view" }, { "const": "queue.manage" }, { "const": "queue.override" }, { "const": "job.create" }, { "const": "job.edit.own" }, { "const": "job.edit.all" }, { "const": "job.delete.own" }, { "const": "job.delete.all" }, { "const": "build.view" }, { "const": "build.create" }, { "const": "build.edit" }, { "const": "build.delete" }, { "const": "settings.view" }, { "const": "settings.edit" }, { "const": "integration.view" }, { "const": "integration.manage" }, { "const": "subscription.view" }, { "const": "subscription.manage" }, { "const": "analytics.view" }, { "const": "reports.generate" }, { "const": "audit.log.view" }, { "const": "audit.logs.configure" }, { "const": "order.view" }, { "const": "order.create" }, { "const": "order.edit" }, { "const": "order.delete" }, { "const": "order.print" }, { "const": "apiKey.view" }, { "const": "apiKey.create" }, { "const": "apiKey.edit" }, { "const": "apiKey.delete" }, { "const": "file.download" }, { "const": "maintenance.view" }, { "const": "maintenance.create" }, { "const": "maintenance.edit" }, { "const": "maintenance.delete" }, { "const": "maintenance.complete" }, { "const": "internal.shopify" }, { "const": "queue.admin" }, { "const": "part.viewer" }, { "const": "part.editor" }, { "const": "sku.viewer" }, { "const": "sku.editor" }, { "const": "orders.admin" }, { "const": "material.viewer" }, { "const": "material.editor" }, { "const": "printer.viewer" }, { "const": "printer.editor" }, { "const": "profile.viewer" }, { "const": "profile.editor" }, { "const": "settings.admin" }, { "const": "subscription.admin" } ] } } }, "required": [ "permissions" ] } } }, "required": true }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserDetails" } } } } } }, "put": { "tags": [ "Users" ], "parameters": [ { "name": "userId", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "permissions": { "type": "array", "items": { "oneOf": [ { "const": "organization.owner" }, { "const": "organization.edit" }, { "const": "organization.delete" }, { "const": "user.view" }, { "const": "user.invite" }, { "const": "user.edit" }, { "const": "user.delete" }, { "const": "permission.view" }, { "const": "permission.grant" }, { "const": "permission.revoke" }, { "const": "part.view" }, { "const": "part.create" }, { "const": "part.edit" }, { "const": "part.delete" }, { "const": "part.export" }, { "const": "sku.view" }, { "const": "sku.create" }, { "const": "sku.edit" }, { "const": "sku.delete" }, { "const": "material.view" }, { "const": "material.create" }, { "const": "material.edit" }, { "const": "material.delete" }, { "const": "material.instance.view" }, { "const": "material.instance.create" }, { "const": "material.instance.edit" }, { "const": "material.instance.delete" }, { "const": "printer.view" }, { "const": "printer.create" }, { "const": "printer.edit" }, { "const": "printer.delete" }, { "const": "printer.control" }, { "const": "printer.ready" }, { "const": "printer.config" }, { "const": "printer.stats" }, { "const": "printer.camera" }, { "const": "profile.view" }, { "const": "profile.create" }, { "const": "profile.edit" }, { "const": "profile.delete" }, { "const": "queue.view" }, { "const": "queue.manage" }, { "const": "queue.override" }, { "const": "job.create" }, { "const": "job.edit.own" }, { "const": "job.edit.all" }, { "const": "job.delete.own" }, { "const": "job.delete.all" }, { "const": "build.view" }, { "const": "build.create" }, { "const": "build.edit" }, { "const": "build.delete" }, { "const": "settings.view" }, { "const": "settings.edit" }, { "const": "integration.view" }, { "const": "integration.manage" }, { "const": "subscription.view" }, { "const": "subscription.manage" }, { "const": "analytics.view" }, { "const": "reports.generate" }, { "const": "audit.log.view" }, { "const": "audit.logs.configure" }, { "const": "order.view" }, { "const": "order.create" }, { "const": "order.edit" }, { "const": "order.delete" }, { "const": "order.print" }, { "const": "apiKey.view" }, { "const": "apiKey.create" }, { "const": "apiKey.edit" }, { "const": "apiKey.delete" }, { "const": "file.download" }, { "const": "maintenance.view" }, { "const": "maintenance.create" }, { "const": "maintenance.edit" }, { "const": "maintenance.delete" }, { "const": "maintenance.complete" }, { "const": "internal.shopify" }, { "const": "queue.admin" }, { "const": "part.viewer" }, { "const": "part.editor" }, { "const": "sku.viewer" }, { "const": "sku.editor" }, { "const": "orders.admin" }, { "const": "material.viewer" }, { "const": "material.editor" }, { "const": "printer.viewer" }, { "const": "printer.editor" }, { "const": "profile.viewer" }, { "const": "profile.editor" }, { "const": "settings.admin" }, { "const": "subscription.admin" } ] } } }, "required": [ "permissions" ] } } }, "required": true }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserDetails" } } } } } } }, "/v1/users/bulk": { "post": { "tags": [ "Users" ], "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkUpdateUsersRequest" } } }, "required": true }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkUpdateUsersResponse" } } } } } } }, "/v1/integrations": { "get": { "summary": "Get all integrations", "description": "List all integrations in your store", "tags": [ "Integrations" ], "parameters": [ { "name": "type", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "externalId", "in": "query", "schema": { "type": "string" }, "required": false, "description": "External identifier for deduplication (e.g., shopId for Etsy)" }, { "name": "publicData", "in": "query", "schema": { "type": "string" }, "required": false, "description": "Public metadata safe to expose to frontend" }, { "name": "settings", "in": "query", "schema": { "type": "string" }, "required": false, "description": "User-configurable settings" }, { "name": "id", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "storeId", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "createdAt", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "updatedAt", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "sort", "in": "query", "schema": { "type": "string" }, "required": false, "title": "Sort" }, { "name": "limit", "in": "query", "schema": { "type": "number", "minimum": 1, "maximum": 1000 }, "required": false, "title": "Limit" }, { "name": "offset", "in": "query", "schema": { "type": "number", "minimum": 0 }, "required": false, "title": "Offset" }, { "name": "fields", "in": "query", "schema": { "type": "string" }, "required": false, "title": "Fields" }, { "name": "include", "in": "query", "schema": { "type": "string" }, "required": false, "title": "Include" }, { "name": "meta", "in": "query", "schema": { "type": "boolean" }, "required": false, "title": "Meta" }, { "name": "hints", "in": "query", "schema": { "type": "boolean" }, "required": false, "title": "Hints" } ], "responses": { "200": { "description": "List of integrations", "content": { "application/json": { "schema": { "oneOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/Integration" } }, { "$ref": "#/components/schemas/SearchResponse" } ] } } } } }, "x-permission": "integration.view" } }, "/v1/integrations/search": { "post": { "summary": "Search integrations", "description": "Search integrations with complex filters", "tags": [ "Integrations" ], "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchQueryDtoIntegration" } } }, "required": true }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchResponse" } } } } }, "x-permission": "integration.view" } }, "/v1/integrations/{id}": { "get": { "summary": "Get a specific integration by ID", "tags": [ "Integrations" ], "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true, "description": " - Integration identifier" } ], "responses": { "200": { "description": "Integration details", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Integration" } } } } }, "x-permission": "integration.view" } }, "/v1/sku-builds": { "get": { "summary": "Get all SKU builds for a store", "tags": [ "SKU_Builds" ], "parameters": [ { "name": "skuId", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "skuCopy", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "status", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "skuInstanceStart", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "orderId", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "orderItemId", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "priority", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "selectedOptions", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "id", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "storeId", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "createdAt", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "updatedAt", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "sort", "in": "query", "schema": { "type": "string" }, "required": false, "title": "Sort" }, { "name": "limit", "in": "query", "schema": { "type": "number", "minimum": 1, "maximum": 1000 }, "required": false, "title": "Limit" }, { "name": "offset", "in": "query", "schema": { "type": "number", "minimum": 0 }, "required": false, "title": "Offset" }, { "name": "fields", "in": "query", "schema": { "type": "string" }, "required": false, "title": "Fields" }, { "name": "include", "in": "query", "schema": { "type": "string" }, "required": false, "title": "Include" }, { "name": "meta", "in": "query", "schema": { "type": "boolean" }, "required": false, "title": "Meta" }, { "name": "hints", "in": "query", "schema": { "type": "boolean" }, "required": false, "title": "Hints" } ], "responses": { "200": { "description": "List of SKU builds with their part builds", "content": { "application/json": { "schema": { "oneOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/SkuBuildWithRelation" } }, { "$ref": "#/components/schemas/SearchResponse" } ] } } } } }, "x-permission": "queue.view" } }, "/v1/sku-builds/search": { "post": { "summary": "Search SKU builds", "description": "Search SKU builds with complex filters", "tags": [ "SKU_Builds" ], "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchQueryDtoSkuBuild" } } }, "required": true }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchResponse" } } } } }, "x-permission": "queue.view" } }, "/v1/sku-builds/{id}": { "get": { "summary": "Get a specific SKU build by ID", "tags": [ "SKU_Builds" ], "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true, "description": " - SKU build identifier" } ], "responses": { "200": { "description": "SKU build with part builds, steps, and print jobs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SkuBuildWithRelation" } } } } }, "x-permission": "queue.view" } }, "/v1/part-build-steps": { "get": { "summary": "Get all part build steps", "description": "List all part build steps in your store", "tags": [ "Part_Builds" ], "parameters": [ { "name": "partBuildId", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "order", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "builder", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "inputFiles", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "inputParameters", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "inputHash", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "cachedBuildStepId", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "cachedOutputFile", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "outputFiles", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "status", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "logs", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "requiresAssignedPrinter", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "nextStepId", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "startedAt", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "completedAt", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "dismissed", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "id", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "storeId", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "createdAt", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "updatedAt", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "sort", "in": "query", "schema": { "type": "string" }, "required": false, "title": "Sort" }, { "name": "limit", "in": "query", "schema": { "type": "number", "minimum": 1, "maximum": 1000 }, "required": false, "title": "Limit" }, { "name": "offset", "in": "query", "schema": { "type": "number", "minimum": 0 }, "required": false, "title": "Offset" }, { "name": "fields", "in": "query", "schema": { "type": "string" }, "required": false, "title": "Fields" }, { "name": "include", "in": "query", "schema": { "type": "string" }, "required": false, "title": "Include" }, { "name": "meta", "in": "query", "schema": { "type": "boolean" }, "required": false, "title": "Meta" }, { "name": "hints", "in": "query", "schema": { "type": "boolean" }, "required": false, "title": "Hints" } ], "responses": { "200": { "description": "List of part build steps", "content": { "application/json": { "schema": { "oneOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/PartBuildStep" } }, { "$ref": "#/components/schemas/SearchResponse" } ] } } } } }, "x-permission": "build.view" } }, "/v1/part-build-steps/search": { "post": { "summary": "Search part build steps", "description": "Search part build steps with complex filters", "tags": [ "Part_Builds" ], "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchQueryDtoPartBuildStep" } } }, "required": true }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchResponse" } } } } }, "x-permission": "build.view" } }, "/v1/part-build-steps/{id}": { "get": { "summary": "Get a specific part build step by ID", "tags": [ "Part_Builds" ], "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true, "description": " - Part build step identifier" } ], "responses": { "200": { "description": "Part build step details, or undefined if not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartBuildStep" } } } } }, "x-permission": "build.view" } }, "/v1/folders": { "get": { "summary": "Get all folders", "tags": [ "Folders" ], "parameters": [ { "name": "type", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "name", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "parentId", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "id", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "storeId", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "createdAt", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "updatedAt", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "sort", "in": "query", "schema": { "type": "string" }, "required": false, "title": "Sort" }, { "name": "limit", "in": "query", "schema": { "type": "number", "minimum": 1, "maximum": 1000 }, "required": false, "title": "Limit" }, { "name": "offset", "in": "query", "schema": { "type": "number", "minimum": 0 }, "required": false, "title": "Offset" }, { "name": "fields", "in": "query", "schema": { "type": "string" }, "required": false, "title": "Fields" }, { "name": "include", "in": "query", "schema": { "type": "string" }, "required": false, "title": "Include" }, { "name": "meta", "in": "query", "schema": { "type": "boolean" }, "required": false, "title": "Meta" }, { "name": "hints", "in": "query", "schema": { "type": "boolean" }, "required": false, "title": "Hints" } ], "responses": { "200": { "description": "List of all folders in the store", "content": { "application/json": { "schema": { "oneOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/Folder" } }, { "$ref": "#/components/schemas/SearchResponse" } ] } } } } }, "x-permission": "part.view" }, "post": { "summary": "Create a new folder", "tags": [ "Folders" ], "parameters": [], "requestBody": { "description": "Folder creation details", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateFolderRequest" } } }, "required": true }, "responses": { "201": { "description": "The created folder", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Folder" } } } } }, "x-permission": "part.create" } }, "/v1/folders/search": { "post": { "summary": "Search folders", "description": "Search folders with complex filters", "tags": [ "Folders" ], "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchQueryDtoFolder" } } }, "required": true }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchResponse" } } } } }, "x-permission": "part.view" } }, "/v1/folders/move": { "patch": { "summary": "Move folders to a new parent", "tags": [ "Folders" ], "parameters": [], "requestBody": { "description": "Batch move request with folder IDs and new parent", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchMoveFolderRequest" } } }, "required": true }, "responses": { "200": { "description": "Move operation result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchMoveFolderResponse" } } } } }, "x-permission": "part.edit" } }, "/v1/folders/rename": { "patch": { "summary": "Rename a folder", "tags": [ "Folders" ], "parameters": [], "requestBody": { "description": "Folder ID and new name", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RenameFolderRequest" } } }, "required": true }, "responses": { "200": { "description": "The updated folder", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Folder" } } } } }, "x-permission": "part.edit" } }, "/v1/folders/by-type/{type}": { "get": { "summary": "Get folders by type", "tags": [ "Folders" ], "parameters": [ { "name": "type", "in": "path", "schema": { "type": "string" }, "required": true, "description": " Folder type (part, sku, etc.)" } ], "responses": { "200": { "description": "List of folders of specified type", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Folder" } } } } } }, "x-permission": "part.view" } }, "/v1/folders/parts": { "get": { "summary": "Get part folders", "tags": [ "Folders" ], "parameters": [], "responses": { "200": { "description": "List of folders for parts", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Folder" } } } } } }, "x-permission": "part.view" } }, "/v1/folders/skus": { "get": { "summary": "Get SKU folders", "tags": [ "Folders" ], "parameters": [], "responses": { "200": { "description": "List of folders for SKUs", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Folder" } } } } } }, "x-permission": "sku.view" } }, "/v1/folders/delete": { "delete": { "summary": "Delete folders", "tags": [ "Folders" ], "parameters": [], "requestBody": { "description": "List of folder IDs to delete", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteFolderRequest" } } }, "required": true }, "responses": { "200": { "description": "Deletion result with affected count", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "affected": { "type": "number" }, "message": { "type": "string" } }, "required": [ "success", "affected" ] } } } } }, "x-permission": "part.delete" } }, "/v1/folders/{id}": { "get": { "summary": "Get folder by ID", "tags": [ "Folders" ], "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true, "description": " Folder ID" } ], "responses": { "200": { "description": "The requested folder", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Folder" } } } } }, "x-permission": "part.view" } }, "/v1/entitlements": { "get": { "summary": "Get all entitlements", "tags": [ "Entitlements" ], "parameters": [ { "name": "entitlement", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "enabledAt", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "id", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "storeId", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "createdAt", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "updatedAt", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "sort", "in": "query", "schema": { "type": "string" }, "required": false, "title": "Sort" }, { "name": "limit", "in": "query", "schema": { "type": "number", "minimum": 1, "maximum": 1000 }, "required": false, "title": "Limit" }, { "name": "offset", "in": "query", "schema": { "type": "number", "minimum": 0 }, "required": false, "title": "Offset" }, { "name": "fields", "in": "query", "schema": { "type": "string" }, "required": false, "title": "Fields" }, { "name": "include", "in": "query", "schema": { "type": "string" }, "required": false, "title": "Include" }, { "name": "meta", "in": "query", "schema": { "type": "boolean" }, "required": false, "title": "Meta" }, { "name": "hints", "in": "query", "schema": { "type": "boolean" }, "required": false, "title": "Hints" } ], "responses": { "200": { "description": "List of all entitlements for the store", "content": { "application/json": { "schema": { "oneOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/Entitlement" } }, { "$ref": "#/components/schemas/SearchResponse" } ] } } } } } } }, "/v1/entitlements/search": { "post": { "summary": "Search entitlements", "description": "Search entitlements with complex filters", "tags": [ "Entitlements" ], "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchQueryDtoEntitlement" } } }, "required": true }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchResponse" } } } } } } }, "/v1/entitlements/{id}": { "get": { "summary": "Get entitlement by ID", "tags": [ "Entitlements" ], "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true, "description": " Entitlement ID" } ], "responses": { "200": { "description": "The requested entitlement", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entitlement" } } } } } } }, "/v1/entitlements/check/{entitlement}": { "get": { "summary": "Check if store has specific entitlement", "tags": [ "Entitlements" ], "parameters": [ { "name": "entitlement", "in": "path", "schema": { "type": "string" }, "required": true, "description": " Entitlement name to check" } ], "responses": { "200": { "description": "Whether the store has the entitlement", "content": { "application/json": { "schema": { "type": "object", "properties": { "hasEntitlement": { "type": "boolean" } }, "required": [ "hasEntitlement" ] } } } } } } }, "/v1/permissions/types": { "get": { "summary": "List permission types", "description": "List all available permission types", "tags": [ "Permissions" ], "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "oneOf": [ { "const": "organization.owner" }, { "const": "organization.edit" }, { "const": "organization.delete" }, { "const": "user.view" }, { "const": "user.invite" }, { "const": "user.edit" }, { "const": "user.delete" }, { "const": "permission.view" }, { "const": "permission.grant" }, { "const": "permission.revoke" }, { "const": "part.view" }, { "const": "part.create" }, { "const": "part.edit" }, { "const": "part.delete" }, { "const": "part.export" }, { "const": "sku.view" }, { "const": "sku.create" }, { "const": "sku.edit" }, { "const": "sku.delete" }, { "const": "material.view" }, { "const": "material.create" }, { "const": "material.edit" }, { "const": "material.delete" }, { "const": "material.instance.view" }, { "const": "material.instance.create" }, { "const": "material.instance.edit" }, { "const": "material.instance.delete" }, { "const": "printer.view" }, { "const": "printer.create" }, { "const": "printer.edit" }, { "const": "printer.delete" }, { "const": "printer.control" }, { "const": "printer.ready" }, { "const": "printer.config" }, { "const": "printer.stats" }, { "const": "printer.camera" }, { "const": "profile.view" }, { "const": "profile.create" }, { "const": "profile.edit" }, { "const": "profile.delete" }, { "const": "queue.view" }, { "const": "queue.manage" }, { "const": "queue.override" }, { "const": "job.create" }, { "const": "job.edit.own" }, { "const": "job.edit.all" }, { "const": "job.delete.own" }, { "const": "job.delete.all" }, { "const": "build.view" }, { "const": "build.create" }, { "const": "build.edit" }, { "const": "build.delete" }, { "const": "settings.view" }, { "const": "settings.edit" }, { "const": "integration.view" }, { "const": "integration.manage" }, { "const": "subscription.view" }, { "const": "subscription.manage" }, { "const": "analytics.view" }, { "const": "reports.generate" }, { "const": "audit.log.view" }, { "const": "audit.logs.configure" }, { "const": "order.view" }, { "const": "order.create" }, { "const": "order.edit" }, { "const": "order.delete" }, { "const": "order.print" }, { "const": "apiKey.view" }, { "const": "apiKey.create" }, { "const": "apiKey.edit" }, { "const": "apiKey.delete" }, { "const": "file.download" }, { "const": "maintenance.view" }, { "const": "maintenance.create" }, { "const": "maintenance.edit" }, { "const": "maintenance.delete" }, { "const": "maintenance.complete" }, { "const": "internal.shopify" }, { "const": "queue.admin" }, { "const": "part.viewer" }, { "const": "part.editor" }, { "const": "sku.viewer" }, { "const": "sku.editor" }, { "const": "orders.admin" }, { "const": "material.viewer" }, { "const": "material.editor" }, { "const": "printer.viewer" }, { "const": "printer.editor" }, { "const": "profile.viewer" }, { "const": "profile.editor" }, { "const": "settings.admin" }, { "const": "subscription.admin" } ] } } } } } }, "x-permission": "permission.view" } }, "/v1/permissions": { "get": { "summary": "Get all permissions", "description": "List all permissions in your store", "tags": [ "Permissions" ], "parameters": [ { "name": "userId", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "permission", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "storeId", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "id", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "createdAt", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "updatedAt", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "sort", "in": "query", "schema": { "type": "string" }, "required": false, "title": "Sort" }, { "name": "limit", "in": "query", "schema": { "type": "number", "minimum": 1, "maximum": 1000 }, "required": false, "title": "Limit" }, { "name": "offset", "in": "query", "schema": { "type": "number", "minimum": 0 }, "required": false, "title": "Offset" }, { "name": "fields", "in": "query", "schema": { "type": "string" }, "required": false, "title": "Fields" }, { "name": "include", "in": "query", "schema": { "type": "string" }, "required": false, "title": "Include" }, { "name": "meta", "in": "query", "schema": { "type": "boolean" }, "required": false, "title": "Meta" }, { "name": "hints", "in": "query", "schema": { "type": "boolean" }, "required": false, "title": "Hints" } ], "responses": { "200": { "description": "List of all permissions", "content": { "application/json": { "schema": { "oneOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/Permission" } }, { "$ref": "#/components/schemas/SearchResponse" } ] } } } } }, "x-permission": "permission.view" } }, "/v1/permissions/search": { "post": { "summary": "Search permissions", "description": "Search permissions with complex filters", "tags": [ "Permissions" ], "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchQueryDtoPermission" } } }, "required": true }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchResponse" } } } } }, "x-permission": "permission.view" } }, "/v1/permissions/user/{userId}": { "get": { "tags": [ "Users" ], "parameters": [ { "name": "userId", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetAllPermissionsForUserResponse" } } } } } } }, "/v1/roles": { "get": { "tags": [ "Users" ], "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RoleSummary" } } } } } } } }, "/v1/roles/with-permissions": { "get": { "tags": [ "Users" ], "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RoleWithPermissions" } } } } } } } }, "/v1/roles/{roleId}/permissions": { "get": { "tags": [ "Users" ], "parameters": [ { "name": "roleId", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "oneOf": [ { "const": "organization.owner" }, { "const": "organization.edit" }, { "const": "organization.delete" }, { "const": "user.view" }, { "const": "user.invite" }, { "const": "user.edit" }, { "const": "user.delete" }, { "const": "permission.view" }, { "const": "permission.grant" }, { "const": "permission.revoke" }, { "const": "part.view" }, { "const": "part.create" }, { "const": "part.edit" }, { "const": "part.delete" }, { "const": "part.export" }, { "const": "sku.view" }, { "const": "sku.create" }, { "const": "sku.edit" }, { "const": "sku.delete" }, { "const": "material.view" }, { "const": "material.create" }, { "const": "material.edit" }, { "const": "material.delete" }, { "const": "material.instance.view" }, { "const": "material.instance.create" }, { "const": "material.instance.edit" }, { "const": "material.instance.delete" }, { "const": "printer.view" }, { "const": "printer.create" }, { "const": "printer.edit" }, { "const": "printer.delete" }, { "const": "printer.control" }, { "const": "printer.ready" }, { "const": "printer.config" }, { "const": "printer.stats" }, { "const": "printer.camera" }, { "const": "profile.view" }, { "const": "profile.create" }, { "const": "profile.edit" }, { "const": "profile.delete" }, { "const": "queue.view" }, { "const": "queue.manage" }, { "const": "queue.override" }, { "const": "job.create" }, { "const": "job.edit.own" }, { "const": "job.edit.all" }, { "const": "job.delete.own" }, { "const": "job.delete.all" }, { "const": "build.view" }, { "const": "build.create" }, { "const": "build.edit" }, { "const": "build.delete" }, { "const": "settings.view" }, { "const": "settings.edit" }, { "const": "integration.view" }, { "const": "integration.manage" }, { "const": "subscription.view" }, { "const": "subscription.manage" }, { "const": "analytics.view" }, { "const": "reports.generate" }, { "const": "audit.log.view" }, { "const": "audit.logs.configure" }, { "const": "order.view" }, { "const": "order.create" }, { "const": "order.edit" }, { "const": "order.delete" }, { "const": "order.print" }, { "const": "apiKey.view" }, { "const": "apiKey.create" }, { "const": "apiKey.edit" }, { "const": "apiKey.delete" }, { "const": "file.download" }, { "const": "maintenance.view" }, { "const": "maintenance.create" }, { "const": "maintenance.edit" }, { "const": "maintenance.delete" }, { "const": "maintenance.complete" }, { "const": "internal.shopify" }, { "const": "queue.admin" }, { "const": "part.viewer" }, { "const": "part.editor" }, { "const": "sku.viewer" }, { "const": "sku.editor" }, { "const": "orders.admin" }, { "const": "material.viewer" }, { "const": "material.editor" }, { "const": "printer.viewer" }, { "const": "printer.editor" }, { "const": "profile.viewer" }, { "const": "profile.editor" }, { "const": "settings.admin" }, { "const": "subscription.admin" } ] } } } } } } } }, "/v1/printer-commands/send": { "post": { "summary": "Send command to printers", "tags": [ "Printers" ], "parameters": [], "requestBody": { "description": "Printer IDs and command to send", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SendCommandRequest" } } }, "required": true }, "responses": { "201": { "description": "List of printer IDs that received the command", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } } }, "x-permission": "printer.control" } }, "/v1/settings/store": { "get": { "summary": "Get store settings", "tags": [ "Settings" ], "parameters": [], "responses": { "200": { "description": "Current settings for the store", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetStoreSettingsResponse" } } } } }, "x-permission": "settings.view" }, "patch": { "summary": "Update store settings", "tags": [ "Settings" ], "parameters": [], "requestBody": { "description": "Settings to update", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateStoreSettingsRequest" } } }, "required": true }, "responses": { "200": { "description": "Updated store settings", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetStoreSettingsResponse" } } } } }, "x-permission": "settings.edit" } }, "/v1/settings/slicers": { "get": { "summary": "Get available slicer versions", "tags": [ "Settings" ], "parameters": [], "responses": { "200": { "description": "List of all supported slicer versions", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetAllSlicerVersionsResponse" } } } } }, "x-permission": "settings.view" } }, "/v1/settings/notifications/search": { "post": { "summary": "Search notification settings", "tags": [ "Settings" ], "parameters": [], "requestBody": { "description": "Search query with filters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchQueryDtoNotificationSetting" } } }, "required": true }, "responses": { "201": { "description": "Search results with notification settings", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchResponse" } } } } }, "x-permission": "settings.view" } }, "/v1/settings/store/search": { "post": { "summary": "Search store settings", "tags": [ "Settings" ], "parameters": [], "requestBody": { "description": "Search query with filters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchQueryDtoStoreSettings" } } }, "required": true }, "responses": { "201": { "description": "Search results with store settings", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchResponse" } } } } }, "x-permission": "settings.view" } }, "/v1/materials": { "get": { "summary": "Get all materials", "description": "List all material types (e.g., PLA, PETG, ABS)", "tags": [ "Materials" ], "parameters": [ { "name": "name", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "brand", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "type", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "identifier", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "tags", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "filamentUserProfileId", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "filamentSystemProfileId", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "starred", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "pricePer1000g", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "source", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "externalId", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "id", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "storeId", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "createdAt", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "updatedAt", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "sort", "in": "query", "schema": { "type": "string" }, "required": false, "title": "Sort" }, { "name": "limit", "in": "query", "schema": { "type": "number", "minimum": 1, "maximum": 1000 }, "required": false, "title": "Limit" }, { "name": "offset", "in": "query", "schema": { "type": "number", "minimum": 0 }, "required": false, "title": "Offset" }, { "name": "fields", "in": "query", "schema": { "type": "string" }, "required": false, "title": "Fields" }, { "name": "include", "in": "query", "schema": { "type": "string" }, "required": false, "title": "Include" }, { "name": "meta", "in": "query", "schema": { "type": "boolean" }, "required": false, "title": "Meta" }, { "name": "hints", "in": "query", "schema": { "type": "boolean" }, "required": false, "title": "Hints" } ], "responses": { "200": { "description": "All material types in your inventory", "content": { "application/json": { "schema": { "oneOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/Material" } }, { "$ref": "#/components/schemas/SearchResponse" } ] } } } } }, "x-permission": "material.view" }, "post": { "summary": "Create material", "description": "Create a new material type", "tags": [ "Materials" ], "parameters": [], "requestBody": { "description": "Material type data", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MaterialInsert" } } }, "required": true }, "responses": { "201": { "description": "The created material", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Material" } } } } }, "x-permission": "material.create" }, "delete": { "summary": "Delete materials", "description": "Delete multiple material types", "tags": [ "Materials" ], "parameters": [], "requestBody": { "description": "Material IDs to delete", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string", "pattern": "^[a-z0-9]{24}$" } } } }, "required": true }, "responses": { "200": { "description": "IDs of deleted materials", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } } }, "x-permission": "material.delete" } }, "/v1/materials/search": { "post": { "summary": "Search materials", "description": "Search materials with complex filters", "tags": [ "Materials" ], "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchQueryDtoMaterial" } } }, "required": true }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchResponse" } } } } }, "x-permission": "material.view" } }, "/v1/materials/full": { "get": { "summary": "Get full material data", "description": "Get complete material data including variants, groups, instances, and assignments", "tags": [ "Materials" ], "parameters": [], "responses": { "200": { "description": "All material-related data in one response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MaterialsData" } } } } }, "x-permission": "material.view" } }, "/v1/materials/variants": { "get": { "summary": "Get all variants", "description": "List all material variants (specific colors/brands of a material type)", "tags": [ "Material_Variants" ], "parameters": [], "responses": { "200": { "description": "All material variants", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MaterialVariant" } } } } } }, "x-permission": "material.view" }, "post": { "summary": "Create variant", "description": "Create a new material variant (e.g., \"Bambu PLA Basic - Red\")", "tags": [ "Material_Variants" ], "parameters": [], "requestBody": { "description": "Variant data including material type and color", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MaterialVariantInsert" } } }, "required": true }, "responses": { "201": { "description": "The created variant", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MaterialVariant" } } } } }, "x-permission": "material.create" }, "delete": { "summary": "Delete multiple variants", "description": "Delete multiple variants", "tags": [ "Material_Variants" ], "parameters": [], "requestBody": { "description": "Variant IDs to delete", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string", "pattern": "^[a-z0-9]{24}$" } } } }, "required": true }, "responses": { "200": { "description": "IDs of deleted variants", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } } }, "x-permission": "material.delete" } }, "/v1/materials/variants/{id}": { "get": { "summary": "Get variant by ID", "description": "Get a specific material variant", "tags": [ "Material_Variants" ], "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true, "description": " Variant ID" } ], "responses": { "200": { "description": "The requested variant", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MaterialVariant" } } } } }, "x-permission": "material.view" }, "patch": { "summary": "Update variant", "description": "Update a variant's properties", "tags": [ "Material_Variants" ], "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true, "description": " Variant ID" } ], "requestBody": { "description": "Fields to update", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartialMaterialVariant" } } }, "required": true }, "responses": { "200": { "description": "The updated variant", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MaterialVariant" } } } } }, "x-permission": "material.edit" }, "delete": { "summary": "Delete variant", "description": "Delete a material variant", "tags": [ "Material_Variants" ], "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true, "description": " Variant ID" } ], "responses": { "200": { "description": "IDs of deleted resources", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } } }, "x-permission": "material.delete" } }, "/v1/materials/variants/batch": { "post": { "summary": "Batch create variants", "description": "Create multiple variants at once", "tags": [ "Material_Variants" ], "parameters": [], "requestBody": { "description": "Array of variant data", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MaterialVariantInsert" } } } }, "required": true }, "responses": { "201": { "description": "The created variants", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MaterialVariant" } } } } } }, "x-permission": "material.create" } }, "/v1/materials/groups": { "get": { "summary": "Get all groups", "description": "List all material groups for organizing compatible materials", "tags": [ "Material_Groups" ], "parameters": [], "responses": { "200": { "description": "All material groups", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MaterialGroup" } } } } } }, "x-permission": "material.view" }, "post": { "summary": "Create group", "description": "Create a group to organize interchangeable materials", "tags": [ "Material_Groups" ], "parameters": [], "requestBody": { "description": "Group name and configuration", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MaterialGroupInsert" } } }, "required": true }, "responses": { "201": { "description": "The created group", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MaterialGroup" } } } } }, "x-permission": "material.edit" }, "delete": { "summary": "Delete multiple groups", "description": "Delete multiple groups", "tags": [ "Material_Groups" ], "parameters": [], "requestBody": { "description": "Group IDs to delete", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string", "pattern": "^[a-z0-9]{24}$" } } } }, "required": true }, "responses": { "200": { "description": "IDs of deleted groups", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } } }, "x-permission": "material.edit" } }, "/v1/materials/groups/{id}": { "get": { "summary": "Get group by ID", "description": "Get a specific material group", "tags": [ "Material_Groups" ], "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true, "description": " Group ID" } ], "responses": { "200": { "description": "The requested group", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MaterialGroup" } } } } }, "x-permission": "material.view" }, "patch": { "summary": "Update group", "description": "Update a material group's properties", "tags": [ "Material_Groups" ], "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true, "description": " Group ID" } ], "requestBody": { "description": "Fields to update", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartialMaterialGroup" } } }, "required": true }, "responses": { "200": { "description": "The updated group", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MaterialGroup" } } } } }, "x-permission": "material.edit" }, "delete": { "summary": "Delete group", "description": "Delete a material group", "tags": [ "Material_Groups" ], "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true, "description": " Group ID" } ], "responses": { "200": { "description": "IDs of deleted resources", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } } }, "x-permission": "material.edit" } }, "/v1/materials/group-members": { "get": { "summary": "Get all group members", "description": "List all group memberships (variants assigned to groups)", "tags": [ "Material_Groups" ], "parameters": [], "responses": { "200": { "description": "All group membership records", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MaterialGroupMember" } } } } } }, "x-permission": "material.view" }, "post": { "summary": "Add group member", "description": "Add a variant to a group", "tags": [ "Material_Groups" ], "parameters": [], "requestBody": { "description": "Variant and group IDs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MaterialGroupMemberInsert" } } }, "required": true }, "responses": { "201": { "description": "The created membership", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MaterialGroupMember" } } } } }, "x-permission": "material.edit" }, "delete": { "summary": "Remove group members", "description": "Remove variants from groups", "tags": [ "Material_Groups" ], "parameters": [], "requestBody": { "description": "Membership IDs to remove", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string", "pattern": "^[a-z0-9]{24}$" } } } }, "required": true }, "responses": { "200": { "description": "IDs of removed memberships", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string", "pattern": "^[a-z0-9]{24}$" } } } } } }, "x-permission": "material.edit" } }, "/v1/materials/group-members/group/{groupId}": { "get": { "summary": "Get group members", "description": "Get members of a specific group", "tags": [ "Material_Groups" ], "parameters": [ { "name": "groupId", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true, "description": " Group ID" } ], "responses": { "200": { "description": "Variants in the group", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MaterialGroupMember" } } } } } }, "x-permission": "material.view" } }, "/v1/materials/group-members/{id}": { "get": { "summary": "Get group member by ID", "description": "Get a specific group member record", "tags": [ "Material_Groups" ], "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true, "description": " Membership ID" } ], "responses": { "200": { "description": "The membership record", "content": { "application/json": { "schema": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/MaterialGroupMember" } ] } } } } }, "x-permission": "material.view" } }, "/v1/materials/instances": { "get": { "summary": "Get all material instances", "description": "List all physical filament spools in your inventory", "tags": [ "Material_Instances" ], "parameters": [], "responses": { "200": { "description": "All material instances (spools)", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MaterialInstance" } } } } } }, "x-permission": "material.instance.view" }, "post": { "summary": "Create material instance", "description": "Add a new spool to your inventory", "tags": [ "Material_Instances" ], "parameters": [], "requestBody": { "description": "Spool data with variant and remaining weight", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MaterialInstanceInsert" } } }, "required": true }, "responses": { "201": { "description": "The created instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MaterialInstance" } } } } }, "x-permission": "material.instance.create" } }, "/v1/materials/instances/{id}": { "get": { "summary": "Get instance by ID", "description": "Get a specific material instance (spool)", "tags": [ "Material_Instances" ], "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true, "description": " Instance ID" } ], "responses": { "200": { "description": "The instance details", "content": { "application/json": { "schema": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/MaterialInstance" } ] } } } } }, "x-permission": "material.instance.view" }, "put": { "summary": "Update material instance", "description": "Update spool information (e.g., remaining weight)", "tags": [ "Material_Instances" ], "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true, "description": " Instance ID" } ], "requestBody": { "description": "Fields to update", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartialMaterialInstance" } } }, "required": true }, "responses": { "200": { "description": "The updated instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MaterialInstance" } } } } }, "x-permission": "material.instance.edit" }, "delete": { "summary": "Delete material instance", "description": "Remove a spool from inventory", "tags": [ "Material_Instances" ], "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true, "description": " Instance ID" } ], "responses": { "200": { "description": "IDs of deleted resources", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } } }, "x-permission": "material.instance.delete" } }, "/v1/materials/printer-slots": { "get": { "summary": "Get all printer slots", "description": "List all printer filament slot configurations", "tags": [ "Printer_Slots" ], "parameters": [], "responses": { "200": { "description": "All printer slot configurations", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PrinterSlot" } } } } } }, "x-permission": "printer.view" } }, "/v1/materials/printer-slots/assign": { "patch": { "summary": "Assign to printer slots", "description": "Assign materials to printer filament slots (AMS slots)", "tags": [ "Printer_Slots" ], "parameters": [], "requestBody": { "description": "Printer IDs, visual slot positions, and material to assign", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/printerIdsCuid2visualSlotsVisualSlotsetOnPrinterbooleanundefinedmaterialTypestringfilamentUserProfileIdCuid2nullundefinedfilamentSystemProfileIdnumber...1more...undefinedvariantIdnullundefinedmaterialIdnullundefinedinstanceIdnullundefined..." }, { "$ref": "#/components/schemas/printerIdsCuid2visualSlotsVisualSlotsetOnPrinterbooleanundefinedinstanceIdCuid2filamentUserProfileIdCuid2nullundefinedfilamentSystemProfileIdnumber...1more...undefinedvariantIdnullundefinedmaterialIdnullundefinedmaterialTypenullundefined" }, { "$ref": "#/components/schemas/printerIdsCuid2visualSlotsVisualSlotsetOnPrinterbooleanundefinedvariantIdCuid2filamentUserProfileIdCuid2nullundefinedfilamentSystemProfileIdnumber...1more...undefinedinstanceIdnullundefinedmaterialIdnullundefinedmaterialTypenullundefined" }, { "$ref": "#/components/schemas/printerIdsCuid2visualSlotsVisualSlotsetOnPrinterbooleanundefinedmaterialIdCuid2filamentUserProfileIdCuid2nullundefinedfilamentSystemProfileIdnumber...1more...undefinedinstanceIdnullundefinedvariantIdnullundefinedmaterialTypenullundefined" } ] } } }, "required": true }, "responses": { "200": { "description": "", "content": { "application/json": {} } } }, "x-permission": "printer.edit" } }, "/v1/materials/{materialId}/variants": { "get": { "summary": "Get variants by material", "description": "Get all variants of a specific material type", "tags": [ "Material_Variants" ], "parameters": [ { "name": "materialId", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true, "description": " Material type ID" } ], "responses": { "200": { "description": "Variants for the material", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MaterialVariant" } } } } } }, "x-permission": "material.view" } }, "/v1/materials/{id}/profiles": { "post": { "summary": "Assign profile to material", "description": "Link a slicing profile to a material for automatic profile selection", "tags": [ "Materials" ], "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true, "description": " Material ID" } ], "requestBody": { "description": "Profile assignment data", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/modelIdstringnozzleDiameterstringuserProfileIdnullundefinedsystemProfileIdnumber" }, { "$ref": "#/components/schemas/modelIdstringnozzleDiameterstringuserProfileIdCuid2systemProfileIdnullundefined" } ] } } }, "required": true }, "responses": { "201": { "description": "The created profile assignments", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MaterialProfileAssignment" } } } } } }, "x-permission": "material.edit" }, "delete": { "summary": "Clear material profile", "description": "Remove profile assignment from a material", "tags": [ "Materials" ], "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true, "description": " Material ID" } ], "requestBody": { "description": "Profile to clear", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClearMaterialProfileRequest" } } }, "required": true }, "responses": { "200": { "description": "", "content": { "application/json": {} } } }, "x-permission": "material.edit" } }, "/v1/materials/variants/{variantId}/profiles": { "post": { "summary": "Assign profile to variant", "description": "Link a slicing profile to a variant", "tags": [ "Material_Variants" ], "parameters": [ { "name": "variantId", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true, "description": " Variant ID" } ], "requestBody": { "description": "Profile assignment data", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/modelIdstringnozzleDiameterstringuserProfileIdnullundefinedsystemProfileIdnumber" }, { "$ref": "#/components/schemas/modelIdstringnozzleDiameterstringuserProfileIdCuid2systemProfileIdnullundefined" } ] } } }, "required": true }, "responses": { "201": { "description": "The created profile assignments", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MaterialProfileAssignment" } } } } } }, "x-permission": "material.edit" }, "delete": { "summary": "Clear variant profile", "description": "Remove profile assignment from a variant", "tags": [ "Material_Variants" ], "parameters": [ { "name": "variantId", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true, "description": " Variant ID" } ], "requestBody": { "description": "Profile to clear", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClearMaterialProfileRequest" } } }, "required": true }, "responses": { "200": { "description": "", "content": { "application/json": {} } } }, "x-permission": "material.edit" } }, "/v1/materials/{id}": { "get": { "summary": "Get material by ID", "description": "Get a single material type by ID", "tags": [ "Materials" ], "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true, "description": " Material ID" } ], "responses": { "200": { "description": "The requested material", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Material" } } } } }, "x-permission": "material.view" }, "patch": { "summary": "Update material", "description": "Update a material type's properties", "tags": [ "Materials" ], "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true, "description": " Material ID" } ], "requestBody": { "description": "Fields to update", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateMaterialRequest" } } }, "required": true }, "responses": { "200": { "description": "The updated material", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Material" } } } } }, "x-permission": "material.edit" }, "delete": { "summary": "Delete material", "description": "Delete a material type", "tags": [ "Materials" ], "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true, "description": " Material ID" } ], "responses": { "200": { "description": "IDs of deleted resources", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } } }, "x-permission": "material.delete" } }, "/v1/material-variants": { "get": { "summary": "Get all material variants", "description": "List all material variants (specific colors/brands of a material type)", "tags": [ "Material_Variants" ], "operationId": "materialVariants_getAll", "parameters": [ { "name": "name", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "materialId", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "color", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "tags", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "filamentUserProfileId", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "filamentSystemProfileId", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "pricePer1000g", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "pressureAdvance", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "source", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "externalId", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "id", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "storeId", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "createdAt", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "updatedAt", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "sort", "in": "query", "schema": { "type": "string" }, "required": false, "title": "Sort" }, { "name": "limit", "in": "query", "schema": { "type": "number", "minimum": 1, "maximum": 1000 }, "required": false, "title": "Limit" }, { "name": "offset", "in": "query", "schema": { "type": "number", "minimum": 0 }, "required": false, "title": "Offset" }, { "name": "fields", "in": "query", "schema": { "type": "string" }, "required": false, "title": "Fields" }, { "name": "include", "in": "query", "schema": { "type": "string" }, "required": false, "title": "Include" }, { "name": "meta", "in": "query", "schema": { "type": "boolean" }, "required": false, "title": "Meta" }, { "name": "hints", "in": "query", "schema": { "type": "boolean" }, "required": false, "title": "Hints" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "oneOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/MaterialVariant" } }, { "$ref": "#/components/schemas/SearchResponse" } ] } } } } }, "x-permission": "material.view" } }, "/v1/material-variants/search": { "post": { "summary": "Search material variants", "description": "Search material variants with filters", "tags": [ "Material_Variants" ], "operationId": "materialVariants_search", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchQueryDtoMaterialVariant" } } }, "required": true }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchResponse" } } } } }, "x-permission": "material.view" } }, "/v1/material-profile-assignments": { "get": { "summary": "Get all material profile assignments", "description": "List all material-to-profile assignments for automatic profile selection", "tags": [ "Materials" ], "operationId": "materialProfileAssignments_getAll", "parameters": [ { "name": "modelId", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "nozzleDiameter", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "materialId", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "variantId", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "userProfileId", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "systemProfileId", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "id", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "storeId", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "createdAt", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "updatedAt", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "sort", "in": "query", "schema": { "type": "string" }, "required": false, "title": "Sort" }, { "name": "limit", "in": "query", "schema": { "type": "number", "minimum": 1, "maximum": 1000 }, "required": false, "title": "Limit" }, { "name": "offset", "in": "query", "schema": { "type": "number", "minimum": 0 }, "required": false, "title": "Offset" }, { "name": "fields", "in": "query", "schema": { "type": "string" }, "required": false, "title": "Fields" }, { "name": "include", "in": "query", "schema": { "type": "string" }, "required": false, "title": "Include" }, { "name": "meta", "in": "query", "schema": { "type": "boolean" }, "required": false, "title": "Meta" }, { "name": "hints", "in": "query", "schema": { "type": "boolean" }, "required": false, "title": "Hints" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "oneOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/MaterialProfileAssignment" } }, { "$ref": "#/components/schemas/SearchResponse" } ] } } } } }, "x-permission": "material.view" } }, "/v1/material-profile-assignments/search": { "post": { "summary": "Search material profile assignments", "description": "Search material profile assignments with filters", "tags": [ "Materials" ], "operationId": "materialProfileAssignments_search", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchQueryDtoMaterialProfileAssignment" } } }, "required": true }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchResponse" } } } } }, "x-permission": "material.view" } }, "/v1/printer-slots": { "get": { "summary": "Get all printer slots", "description": "List all printer filament slot configurations (external spool slots and AMS slots)", "tags": [ "Printer_Slots" ], "operationId": "printerSlots_getAll", "parameters": [ { "name": "printerId", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "materialId", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "variantId", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "instanceId", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "materialType", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "expectedData", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "expectedDataSetAt", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "amsIndex", "in": "query", "schema": { "type": "string" }, "required": false, "description": "Visual slot position: -1 for spool, 0+ for AMS array index" }, { "name": "slotIndex", "in": "query", "schema": { "type": "string" }, "required": false, "description": "Slot within AMS, or spool index for multiple spools" }, { "name": "slot", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "filamentUserProfileId", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "filamentSystemProfileId", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "id", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "storeId", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "createdAt", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "updatedAt", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "sort", "in": "query", "schema": { "type": "string" }, "required": false, "title": "Sort" }, { "name": "limit", "in": "query", "schema": { "type": "number", "minimum": 1, "maximum": 1000 }, "required": false, "title": "Limit" }, { "name": "offset", "in": "query", "schema": { "type": "number", "minimum": 0 }, "required": false, "title": "Offset" }, { "name": "fields", "in": "query", "schema": { "type": "string" }, "required": false, "title": "Fields" }, { "name": "include", "in": "query", "schema": { "type": "string" }, "required": false, "title": "Include" }, { "name": "meta", "in": "query", "schema": { "type": "boolean" }, "required": false, "title": "Meta" }, { "name": "hints", "in": "query", "schema": { "type": "boolean" }, "required": false, "title": "Hints" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "oneOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/PrinterSlot" } }, { "$ref": "#/components/schemas/SearchResponse" } ] } } } } }, "x-permission": "printer.view" } }, "/v1/printer-slots/search": { "post": { "summary": "Search printer slots", "description": "Search printer slots with filters", "tags": [ "Printer_Slots" ], "operationId": "printerSlots_search", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchQueryDtoPrinterSlot" } } }, "required": true }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchResponse" } } } } }, "x-permission": "printer.view" } }, "/v1/part-material-assignments": { "get": { "summary": "Get all part material assignments", "description": "List all material assignments to parts for filament channel mapping", "tags": [ "Parts" ], "operationId": "partMaterialAssignments_getAll", "parameters": [ { "name": "id", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "storeId", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "createdAt", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "updatedAt", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "groupId", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "variantId", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "materialId", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "materialType", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "partId", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "index", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "priority", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "sort", "in": "query", "schema": { "type": "string" }, "required": false, "title": "Sort" }, { "name": "limit", "in": "query", "schema": { "type": "number", "minimum": 1, "maximum": 1000 }, "required": false, "title": "Limit" }, { "name": "offset", "in": "query", "schema": { "type": "number", "minimum": 0 }, "required": false, "title": "Offset" }, { "name": "fields", "in": "query", "schema": { "type": "string" }, "required": false, "title": "Fields" }, { "name": "include", "in": "query", "schema": { "type": "string" }, "required": false, "title": "Include" }, { "name": "meta", "in": "query", "schema": { "type": "boolean" }, "required": false, "title": "Meta" }, { "name": "hints", "in": "query", "schema": { "type": "boolean" }, "required": false, "title": "Hints" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "oneOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/PartMaterialAssignment" } }, { "$ref": "#/components/schemas/SearchResponse" } ] } } } } }, "x-permission": "part.view" } }, "/v1/part-material-assignments/search": { "post": { "summary": "Search part material assignments", "description": "Search part material assignments with filters", "tags": [ "Parts" ], "operationId": "partMaterialAssignments_search", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchQueryDtoPartMaterialAssignment" } } }, "required": true }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchResponse" } } } } }, "x-permission": "part.view" } }, "/v1/parts/{partId}/metadata": { "get": { "summary": "Get part metadata", "tags": [ "Parts" ], "parameters": [ { "name": "partId", "in": "path", "schema": { "type": "string" }, "required": true, "description": " Part ID" } ], "responses": { "200": { "description": "Metadata for the specified part", "content": { "application/json": { "schema": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/PartMetadata" } ] } } } } }, "x-permission": "part.view" } }, "/v1/parts/{partId}/estimate": { "post": { "summary": "Trigger part estimation", "tags": [ "Parts" ], "parameters": [ { "name": "partId", "in": "path", "schema": { "type": "string" }, "required": true, "description": " Part ID" } ], "responses": { "201": { "description": "Confirmation message", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } } } }, "x-permission": "part.edit" } }, "/v1/parts/{partId}/reprocess": { "post": { "summary": "Reprocess a part's metadata", "description": "Re-extract metadata, tags, and materials from the part's primary file, and\nre-upload plate images (thumbnails + skip-object pick masks). Useful for\nbackfilling newly-supported extractions (e.g. skip-object info) onto existing\nparts. The heavy, file-stable steps with their own triggers (plate splitting\nand estimation slicing) are skipped. The request resolves once reprocessing\ncompletes, and is rate-limited to once per hour per part.", "tags": [ "Parts" ], "parameters": [ { "name": "partId", "in": "path", "schema": { "type": "string" }, "required": true, "description": " Part ID" } ], "responses": { "201": { "description": "The reprocessed part", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Part" } } } } }, "x-permission": "part.edit" } }, "/v1/sku-variants/values": { "get": { "summary": "Get all variant values for a store", "tags": [ "SKU_Variants" ], "parameters": [], "responses": { "200": { "description": "List of variant values", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SkuOptionValue" } } } } } }, "x-permission": "sku.view" }, "post": { "summary": "Create a new variant value", "tags": [ "SKU_Variants" ], "parameters": [], "requestBody": { "description": "- Variant value data", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateSkuOptionValueRequest" } } }, "required": true }, "responses": { "201": { "description": "Created variant value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SkuOptionValue" } } } } }, "x-permission": "sku.edit" } }, "/v1/sku-options/values": { "get": { "summary": "Get all variant values for a store", "tags": [ "SKU_Variants" ], "parameters": [], "responses": { "200": { "description": "List of variant values", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SkuOptionValue" } } } } } }, "x-permission": "sku.view" }, "post": { "summary": "Create a new variant value", "tags": [ "SKU_Variants" ], "parameters": [], "requestBody": { "description": "- Variant value data", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateSkuOptionValueRequest" } } }, "required": true }, "responses": { "201": { "description": "Created variant value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SkuOptionValue" } } } } }, "x-permission": "sku.edit" } }, "/v1/sku-variants/values/{id}": { "get": { "summary": "Get a specific variant value by ID", "tags": [ "SKU_Variants" ], "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true, "description": " - Variant value identifier" } ], "responses": { "200": { "description": "Variant value details", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SkuOptionValue" } } } } }, "x-permission": "sku.view" }, "patch": { "summary": "Update a variant value", "tags": [ "SKU_Variants" ], "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true, "description": " - Variant value identifier" } ], "requestBody": { "description": "- Updated variant value data", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateSkuOptionValueRequest" } } }, "required": true }, "responses": { "200": { "description": "Updated variant value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SkuOptionValue" } } } } }, "x-permission": "sku.edit" }, "delete": { "summary": "Delete a variant value", "tags": [ "SKU_Variants" ], "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true, "description": " - Variant value identifier" } ], "responses": { "200": { "description": "Array of deleted IDs", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } } }, "x-permission": "sku.edit" } }, "/v1/sku-options/values/{id}": { "get": { "summary": "Get a specific variant value by ID", "tags": [ "SKU_Variants" ], "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true, "description": " - Variant value identifier" } ], "responses": { "200": { "description": "Variant value details", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SkuOptionValue" } } } } }, "x-permission": "sku.view" }, "patch": { "summary": "Update a variant value", "tags": [ "SKU_Variants" ], "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true, "description": " - Variant value identifier" } ], "requestBody": { "description": "- Updated variant value data", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateSkuOptionValueRequest" } } }, "required": true }, "responses": { "200": { "description": "Updated variant value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SkuOptionValue" } } } } }, "x-permission": "sku.edit" }, "delete": { "summary": "Delete a variant value", "tags": [ "SKU_Variants" ], "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true, "description": " - Variant value identifier" } ], "responses": { "200": { "description": "Array of deleted IDs", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } } }, "x-permission": "sku.edit" } }, "/v1/sku-variants/values/reorder": { "post": { "summary": "Reorder a variant value", "tags": [ "SKU_Variants" ], "parameters": [], "requestBody": { "description": "- Reorder request with value ID and new order", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReorderSkuOptionValueRequest" } } }, "required": true }, "responses": { "201": { "description": "Void", "content": { "application/json": {} } } }, "x-permission": "sku.edit" } }, "/v1/sku-options/values/reorder": { "post": { "summary": "Reorder a variant value", "tags": [ "SKU_Variants" ], "parameters": [], "requestBody": { "description": "- Reorder request with value ID and new order", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReorderSkuOptionValueRequest" } } }, "required": true }, "responses": { "201": { "description": "Void", "content": { "application/json": {} } } }, "x-permission": "sku.edit" } }, "/v1/sku-variants/props": { "get": { "summary": "Get all variant properties for a store", "tags": [ "SKU_Variants" ], "parameters": [], "responses": { "200": { "description": "List of variant properties", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SkuOptionProperty" } } } } } }, "x-permission": "sku.view" }, "post": { "summary": "Create a new variant property", "tags": [ "SKU_Variants" ], "parameters": [], "requestBody": { "description": "- Variant property data", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateSkuOptionPropertyRequest" } } }, "required": true }, "responses": { "201": { "description": "Created variant property", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SkuOptionProperty" } } } } }, "x-permission": "sku.edit" } }, "/v1/sku-options/props": { "get": { "summary": "Get all variant properties for a store", "tags": [ "SKU_Variants" ], "parameters": [], "responses": { "200": { "description": "List of variant properties", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SkuOptionProperty" } } } } } }, "x-permission": "sku.view" }, "post": { "summary": "Create a new variant property", "tags": [ "SKU_Variants" ], "parameters": [], "requestBody": { "description": "- Variant property data", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateSkuOptionPropertyRequest" } } }, "required": true }, "responses": { "201": { "description": "Created variant property", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SkuOptionProperty" } } } } }, "x-permission": "sku.edit" } }, "/v1/sku-variants/props/{id}": { "get": { "summary": "Get a specific variant property by ID", "tags": [ "SKU_Variants" ], "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true, "description": " - Property identifier" } ], "responses": { "200": { "description": "Variant property details", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SkuOptionProperty" } } } } }, "x-permission": "sku.view" }, "patch": { "summary": "Update a variant property", "tags": [ "SKU_Variants" ], "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true, "description": " - Property identifier" } ], "requestBody": { "description": "- Updated property data", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateSkuOptionPropertyRequest" } } }, "required": true }, "responses": { "200": { "description": "Updated variant property", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SkuOptionProperty" } } } } }, "x-permission": "sku.edit" }, "delete": { "summary": "Delete a variant property", "tags": [ "SKU_Variants" ], "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true, "description": " - Property identifier" } ], "responses": { "200": { "description": "Array of deleted IDs", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } } }, "x-permission": "sku.edit" } }, "/v1/sku-options/props/{id}": { "get": { "summary": "Get a specific variant property by ID", "tags": [ "SKU_Variants" ], "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true, "description": " - Property identifier" } ], "responses": { "200": { "description": "Variant property details", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SkuOptionProperty" } } } } }, "x-permission": "sku.view" }, "patch": { "summary": "Update a variant property", "tags": [ "SKU_Variants" ], "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true, "description": " - Property identifier" } ], "requestBody": { "description": "- Updated property data", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateSkuOptionPropertyRequest" } } }, "required": true }, "responses": { "200": { "description": "Updated variant property", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SkuOptionProperty" } } } } }, "x-permission": "sku.edit" }, "delete": { "summary": "Delete a variant property", "tags": [ "SKU_Variants" ], "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true, "description": " - Property identifier" } ], "responses": { "200": { "description": "Array of deleted IDs", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } } }, "x-permission": "sku.edit" } }, "/v1/sku-variants/props/reorder": { "post": { "summary": "Reorder a variant property", "tags": [ "SKU_Variants" ], "parameters": [], "requestBody": { "description": "- Reorder request with property ID and new order", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReorderSkuOptionPropertyRequest" } } }, "required": true }, "responses": { "201": { "description": "Void", "content": { "application/json": {} } } }, "x-permission": "sku.edit" } }, "/v1/sku-options/props/reorder": { "post": { "summary": "Reorder a variant property", "tags": [ "SKU_Variants" ], "parameters": [], "requestBody": { "description": "- Reorder request with property ID and new order", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReorderSkuOptionPropertyRequest" } } }, "required": true }, "responses": { "201": { "description": "Void", "content": { "application/json": {} } } }, "x-permission": "sku.edit" } }, "/v1/sku-variants/prop-values": { "get": { "summary": "Get all property values for a store", "tags": [ "SKU_Variants" ], "parameters": [], "responses": { "200": { "description": "List of property values", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SkuOptionPropertyValue" } } } } } }, "x-permission": "sku.view" }, "post": { "summary": "Create multiple property values", "tags": [ "SKU_Variants" ], "parameters": [], "requestBody": { "description": "- Bulk create request with property values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkCreatePropertyValuesRequest" } } }, "required": true }, "responses": { "201": { "description": "Created property values", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SkuOptionPropertyValue" } } } } } }, "x-permission": "sku.edit" }, "patch": { "summary": "Update multiple property values", "tags": [ "SKU_Variants" ], "parameters": [], "requestBody": { "description": "- Bulk update request with property value updates", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkUpdatePropertyValuesRequest" } } }, "required": true }, "responses": { "200": { "description": "Void", "content": { "application/json": {} } } }, "x-permission": "sku.edit" }, "delete": { "summary": "Delete multiple property values", "tags": [ "SKU_Variants" ], "parameters": [], "requestBody": { "description": "- Bulk delete request with IDs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkDeleteRequest" } } }, "required": true }, "responses": { "200": { "description": "Array of deleted IDs", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } } }, "x-permission": "sku.edit" } }, "/v1/sku-options/prop-values": { "get": { "summary": "Get all property values for a store", "tags": [ "SKU_Variants" ], "parameters": [], "responses": { "200": { "description": "List of property values", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SkuOptionPropertyValue" } } } } } }, "x-permission": "sku.view" }, "post": { "summary": "Create multiple property values", "tags": [ "SKU_Variants" ], "parameters": [], "requestBody": { "description": "- Bulk create request with property values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkCreatePropertyValuesRequest" } } }, "required": true }, "responses": { "201": { "description": "Created property values", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SkuOptionPropertyValue" } } } } } }, "x-permission": "sku.edit" }, "patch": { "summary": "Update multiple property values", "tags": [ "SKU_Variants" ], "parameters": [], "requestBody": { "description": "- Bulk update request with property value updates", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkUpdatePropertyValuesRequest" } } }, "required": true }, "responses": { "200": { "description": "Void", "content": { "application/json": {} } } }, "x-permission": "sku.edit" }, "delete": { "summary": "Delete multiple property values", "tags": [ "SKU_Variants" ], "parameters": [], "requestBody": { "description": "- Bulk delete request with IDs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkDeleteRequest" } } }, "required": true }, "responses": { "200": { "description": "Array of deleted IDs", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } } }, "x-permission": "sku.edit" } }, "/v1/sku-variants/prop-values/{id}": { "get": { "summary": "Get a specific property value by ID", "tags": [ "SKU_Variants" ], "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true, "description": " - Property value identifier" } ], "responses": { "200": { "description": "Property value details", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SkuOptionPropertyValue" } } } } }, "x-permission": "sku.view" } }, "/v1/sku-options/prop-values/{id}": { "get": { "summary": "Get a specific property value by ID", "tags": [ "SKU_Variants" ], "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true, "description": " - Property value identifier" } ], "responses": { "200": { "description": "Property value details", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SkuOptionPropertyValue" } } } } }, "x-permission": "sku.view" } }, "/v1/sku-variants": { "get": { "summary": "Get all SKU variants for a store", "tags": [ "SKU_Variants" ], "parameters": [ { "name": "name", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "isPersonalization", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "id", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "storeId", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "createdAt", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "updatedAt", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "sort", "in": "query", "schema": { "type": "string" }, "required": false, "title": "Sort" }, { "name": "limit", "in": "query", "schema": { "type": "number", "minimum": 1, "maximum": 1000 }, "required": false, "title": "Limit" }, { "name": "offset", "in": "query", "schema": { "type": "number", "minimum": 0 }, "required": false, "title": "Offset" }, { "name": "fields", "in": "query", "schema": { "type": "string" }, "required": false, "title": "Fields" }, { "name": "include", "in": "query", "schema": { "type": "string" }, "required": false, "title": "Include" }, { "name": "meta", "in": "query", "schema": { "type": "boolean" }, "required": false, "title": "Meta" }, { "name": "hints", "in": "query", "schema": { "type": "boolean" }, "required": false, "title": "Hints" } ], "responses": { "200": { "description": "List of SKU variants", "content": { "application/json": { "schema": { "oneOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/SkuOption" } }, { "$ref": "#/components/schemas/SearchResponse" } ] } } } } }, "x-permission": "sku.view" }, "post": { "summary": "Create a new SKU variant", "tags": [ "SKU_Variants" ], "parameters": [], "requestBody": { "description": "- SKU variant data", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateSkuOptionRequest" } } }, "required": true }, "responses": { "201": { "description": "Created SKU variant", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SkuOption" } } } } }, "x-permission": "sku.edit" } }, "/v1/sku-options": { "get": { "summary": "Get all SKU variants for a store", "tags": [ "SKU_Variants" ], "parameters": [ { "name": "name", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "isPersonalization", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "id", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "storeId", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "createdAt", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "updatedAt", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "sort", "in": "query", "schema": { "type": "string" }, "required": false, "title": "Sort" }, { "name": "limit", "in": "query", "schema": { "type": "number", "minimum": 1, "maximum": 1000 }, "required": false, "title": "Limit" }, { "name": "offset", "in": "query", "schema": { "type": "number", "minimum": 0 }, "required": false, "title": "Offset" }, { "name": "fields", "in": "query", "schema": { "type": "string" }, "required": false, "title": "Fields" }, { "name": "include", "in": "query", "schema": { "type": "string" }, "required": false, "title": "Include" }, { "name": "meta", "in": "query", "schema": { "type": "boolean" }, "required": false, "title": "Meta" }, { "name": "hints", "in": "query", "schema": { "type": "boolean" }, "required": false, "title": "Hints" } ], "responses": { "200": { "description": "List of SKU variants", "content": { "application/json": { "schema": { "oneOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/SkuOption" } }, { "$ref": "#/components/schemas/SearchResponse" } ] } } } } }, "x-permission": "sku.view" }, "post": { "summary": "Create a new SKU variant", "tags": [ "SKU_Variants" ], "parameters": [], "requestBody": { "description": "- SKU variant data", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateSkuOptionRequest" } } }, "required": true }, "responses": { "201": { "description": "Created SKU variant", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SkuOption" } } } } }, "x-permission": "sku.edit" } }, "/v1/sku-variants/search": { "post": { "summary": "Search SKU options", "description": "Search SKU options with complex filters", "tags": [ "SKU_Variants" ], "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchQueryDtoSkuOption" } } }, "required": true }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchResponse" } } } } }, "x-permission": "sku.view" } }, "/v1/sku-options/search": { "post": { "summary": "Search SKU options", "description": "Search SKU options with complex filters", "tags": [ "SKU_Variants" ], "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchQueryDtoSkuOption" } } }, "required": true }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchResponse" } } } } }, "x-permission": "sku.view" } }, "/v1/sku-variants/{groupId}/values": { "get": { "summary": "Get variant values for a specific group", "tags": [ "SKU_Variants" ], "parameters": [ { "name": "groupId", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true, "description": " - Variant group identifier" } ], "responses": { "200": { "description": "List of variant values in the group", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SkuOptionValue" } } } } } }, "x-permission": "sku.view" } }, "/v1/sku-options/{groupId}/values": { "get": { "summary": "Get variant values for a specific group", "tags": [ "SKU_Variants" ], "parameters": [ { "name": "groupId", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true, "description": " - Variant group identifier" } ], "responses": { "200": { "description": "List of variant values in the group", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SkuOptionValue" } } } } } }, "x-permission": "sku.view" } }, "/v1/sku-variants/bindings": { "get": { "summary": "Get all variant bindings for a store", "tags": [ "SKU_Variants" ], "parameters": [], "responses": { "200": { "description": "List of variant bindings", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SkuOptionBinding" } } } } } }, "x-permission": "sku.view" }, "post": { "summary": "Create a new variant binding", "tags": [ "SKU_Variants" ], "parameters": [], "requestBody": { "description": "- Variant binding data", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateSkuOptionBindingRequest" } } }, "required": true }, "responses": { "201": { "description": "Created variant binding", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SkuOptionBinding" } } } } }, "x-permission": "sku.edit" } }, "/v1/sku-options/bindings": { "get": { "summary": "Get all variant bindings for a store", "tags": [ "SKU_Variants" ], "parameters": [], "responses": { "200": { "description": "List of variant bindings", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SkuOptionBinding" } } } } } }, "x-permission": "sku.view" }, "post": { "summary": "Create a new variant binding", "tags": [ "SKU_Variants" ], "parameters": [], "requestBody": { "description": "- Variant binding data", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateSkuOptionBindingRequest" } } }, "required": true }, "responses": { "201": { "description": "Created variant binding", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SkuOptionBinding" } } } } }, "x-permission": "sku.edit" } }, "/v1/sku-variants/bindings/{id}": { "get": { "summary": "Get a specific variant binding by ID", "tags": [ "SKU_Variants" ], "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true, "description": " - Binding identifier" } ], "responses": { "200": { "description": "Variant binding details", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SkuOptionBinding" } } } } }, "x-permission": "sku.view" }, "patch": { "summary": "Update a variant binding", "tags": [ "SKU_Variants" ], "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true, "description": " - Binding identifier" } ], "requestBody": { "description": "- Updated binding data", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateSkuOptionBindingRequest" } } }, "required": true }, "responses": { "200": { "description": "Updated variant binding", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SkuOptionBinding" } } } } }, "x-permission": "sku.edit" }, "delete": { "summary": "Delete a variant binding", "tags": [ "SKU_Variants" ], "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true, "description": " - Binding identifier" } ], "responses": { "200": { "description": "Array of deleted IDs", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } } }, "x-permission": "sku.edit" } }, "/v1/sku-options/bindings/{id}": { "get": { "summary": "Get a specific variant binding by ID", "tags": [ "SKU_Variants" ], "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true, "description": " - Binding identifier" } ], "responses": { "200": { "description": "Variant binding details", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SkuOptionBinding" } } } } }, "x-permission": "sku.view" }, "patch": { "summary": "Update a variant binding", "tags": [ "SKU_Variants" ], "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true, "description": " - Binding identifier" } ], "requestBody": { "description": "- Updated binding data", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateSkuOptionBindingRequest" } } }, "required": true }, "responses": { "200": { "description": "Updated variant binding", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SkuOptionBinding" } } } } }, "x-permission": "sku.edit" }, "delete": { "summary": "Delete a variant binding", "tags": [ "SKU_Variants" ], "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true, "description": " - Binding identifier" } ], "responses": { "200": { "description": "Array of deleted IDs", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } } }, "x-permission": "sku.edit" } }, "/v1/sku-variants/bindings/{id}/properties": { "get": { "summary": "Get SKU-specific properties", "tags": [ "SKU_Variants" ], "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true, "description": " - Binding identifier" } ], "responses": { "200": { "description": "List of SKU-specific properties that use this binding as a source", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SkuOptionProperty" } } } } } }, "x-permission": "sku.view" } }, "/v1/sku-options/bindings/{id}/properties": { "get": { "summary": "Get SKU-specific properties", "tags": [ "SKU_Variants" ], "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true, "description": " - Binding identifier" } ], "responses": { "200": { "description": "List of SKU-specific properties that use this binding as a source", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SkuOptionProperty" } } } } } }, "x-permission": "sku.view" } }, "/v1/sku-variants/bindings/reorder": { "post": { "summary": "Reorder a variant binding", "tags": [ "SKU_Variants" ], "parameters": [], "requestBody": { "description": "- Reorder request with binding ID and new order", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReorderSkuOptionBindingRequest" } } }, "required": true }, "responses": { "201": { "description": "Void", "content": { "application/json": {} } } }, "x-permission": "sku.edit" } }, "/v1/sku-options/bindings/reorder": { "post": { "summary": "Reorder a variant binding", "tags": [ "SKU_Variants" ], "parameters": [], "requestBody": { "description": "- Reorder request with binding ID and new order", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReorderSkuOptionBindingRequest" } } }, "required": true }, "responses": { "201": { "description": "Void", "content": { "application/json": {} } } }, "x-permission": "sku.edit" } }, "/v1/sku-variants/{id}": { "get": { "summary": "Get a specific SKU variant by ID", "tags": [ "SKU_Variants" ], "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true, "description": " - SKU variant identifier" } ], "responses": { "200": { "description": "SKU variant details", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SkuOption" } } } } }, "x-permission": "sku.view" }, "patch": { "summary": "Update a SKU variant", "tags": [ "SKU_Variants" ], "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true, "description": " - SKU variant identifier" } ], "requestBody": { "description": "- Updated SKU variant data", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateSkuOptionRequest" } } }, "required": true }, "responses": { "200": { "description": "Updated SKU variant", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SkuOption" } } } } }, "x-permission": "sku.edit" }, "delete": { "summary": "Delete a SKU variant", "tags": [ "SKU_Variants" ], "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true, "description": " - SKU variant identifier" } ], "responses": { "200": { "description": "Array of deleted IDs", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } } }, "x-permission": "sku.edit" } }, "/v1/sku-options/{id}": { "get": { "summary": "Get a specific SKU variant by ID", "tags": [ "SKU_Variants" ], "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true, "description": " - SKU variant identifier" } ], "responses": { "200": { "description": "SKU variant details", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SkuOption" } } } } }, "x-permission": "sku.view" }, "patch": { "summary": "Update a SKU variant", "tags": [ "SKU_Variants" ], "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true, "description": " - SKU variant identifier" } ], "requestBody": { "description": "- Updated SKU variant data", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateSkuOptionRequest" } } }, "required": true }, "responses": { "200": { "description": "Updated SKU variant", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SkuOption" } } } } }, "x-permission": "sku.edit" }, "delete": { "summary": "Delete a SKU variant", "tags": [ "SKU_Variants" ], "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true, "description": " - SKU variant identifier" } ], "responses": { "200": { "description": "Array of deleted IDs", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } } }, "x-permission": "sku.edit" } }, "/v1/sku-variants/filters/{skuId}/{optionId}": { "get": { "summary": "Get value filters for a SKU and option", "tags": [ "SKU_Variants" ], "parameters": [ { "name": "skuId", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true, "description": " - SKU identifier" }, { "name": "optionId", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true, "description": " - Option identifier" } ], "responses": { "200": { "description": "List of value filters", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SkuOptionValueFilter" } } } } } }, "x-permission": "sku.view" } }, "/v1/sku-options/filters/{skuId}/{optionId}": { "get": { "summary": "Get value filters for a SKU and option", "tags": [ "SKU_Variants" ], "parameters": [ { "name": "skuId", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true, "description": " - SKU identifier" }, { "name": "optionId", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true, "description": " - Option identifier" } ], "responses": { "200": { "description": "List of value filters", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SkuOptionValueFilter" } } } } } }, "x-permission": "sku.view" } }, "/v1/sku-variants/filters/{skuId}": { "get": { "summary": "Get all value filters for a SKU", "tags": [ "SKU_Variants" ], "parameters": [ { "name": "skuId", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true, "description": " - SKU identifier" } ], "responses": { "200": { "description": "List of all value filters for the SKU", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SkuOptionValueFilter" } } } } } }, "x-permission": "sku.view" } }, "/v1/sku-options/filters/{skuId}": { "get": { "summary": "Get all value filters for a SKU", "tags": [ "SKU_Variants" ], "parameters": [ { "name": "skuId", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true, "description": " - SKU identifier" } ], "responses": { "200": { "description": "List of all value filters for the SKU", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SkuOptionValueFilter" } } } } } }, "x-permission": "sku.view" } }, "/v1/sku-variants/filters": { "put": { "summary": "Set filtered values for a SKU option", "tags": [ "SKU_Variants" ], "parameters": [], "requestBody": { "description": "- Filter configuration with SKU, option, and allowed values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetFilteredValuesRequest" } } }, "required": true }, "responses": { "200": { "description": "Updated value filters", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SkuOptionValueFilter" } } } } } }, "x-permission": "sku.edit" } }, "/v1/sku-options/filters": { "put": { "summary": "Set filtered values for a SKU option", "tags": [ "SKU_Variants" ], "parameters": [], "requestBody": { "description": "- Filter configuration with SKU, option, and allowed values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetFilteredValuesRequest" } } }, "required": true }, "responses": { "200": { "description": "Updated value filters", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SkuOptionValueFilter" } } } } } }, "x-permission": "sku.edit" } }, "/v1/sku-variants/filters/{id}": { "delete": { "summary": "Remove a value filter", "tags": [ "SKU_Variants" ], "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true, "description": " - Filter identifier" } ], "responses": { "200": { "description": "Array of deleted IDs", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } } }, "x-permission": "sku.edit" } }, "/v1/sku-options/filters/{id}": { "delete": { "summary": "Remove a value filter", "tags": [ "SKU_Variants" ], "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true, "description": " - Filter identifier" } ], "responses": { "200": { "description": "Array of deleted IDs", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } } }, "x-permission": "sku.edit" } }, "/v1/sku-variants/filtered-values/{skuId}/{optionId}": { "get": { "summary": "Get filtered option values for a SKU", "tags": [ "SKU_Variants" ], "parameters": [ { "name": "skuId", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true, "description": " - SKU identifier" }, { "name": "optionId", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true, "description": " - Option identifier" } ], "responses": { "200": { "description": "List of allowed option values after filtering", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SkuOptionValue" } } } } } }, "x-permission": "sku.view" } }, "/v1/sku-options/filtered-values/{skuId}/{optionId}": { "get": { "summary": "Get filtered option values for a SKU", "tags": [ "SKU_Variants" ], "parameters": [ { "name": "skuId", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true, "description": " - SKU identifier" }, { "name": "optionId", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true, "description": " - Option identifier" } ], "responses": { "200": { "description": "List of allowed option values after filtering", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SkuOptionValue" } } } } } }, "x-permission": "sku.view" } }, "/v1/sku-variants/sku-match/{skuString}": { "get": { "summary": "Match a SKU string with variants", "tags": [ "SKU_Variants" ], "parameters": [ { "name": "skuString", "in": "path", "schema": { "type": "string" }, "required": true, "description": " - SKU string to match" } ], "responses": { "200": { "description": "Matched SKU with variants or null", "content": { "application/json": { "schema": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/SkuMatchResult" } ] } } } } }, "x-permission": "sku.view" } }, "/v1/sku-options/sku-match/{skuString}": { "get": { "summary": "Match a SKU string with variants", "tags": [ "SKU_Variants" ], "parameters": [ { "name": "skuString", "in": "path", "schema": { "type": "string" }, "required": true, "description": " - SKU string to match" } ], "responses": { "200": { "description": "Matched SKU with variants or null", "content": { "application/json": { "schema": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/SkuMatchResult" } ] } } } } }, "x-permission": "sku.view" } }, "/v1/cost-components": { "get": { "summary": "Get all cost components", "tags": [ "Cost_Catalog" ], "parameters": [ { "name": "id", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "name", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "unit", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "rate", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "type", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "description", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "storeId", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "createdAt", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "updatedAt", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "sort", "in": "query", "schema": { "type": "string" }, "required": false, "title": "Sort" }, { "name": "limit", "in": "query", "schema": { "type": "number", "minimum": 1, "maximum": 1000 }, "required": false, "title": "Limit" }, { "name": "offset", "in": "query", "schema": { "type": "number", "minimum": 0 }, "required": false, "title": "Offset" }, { "name": "fields", "in": "query", "schema": { "type": "string" }, "required": false, "title": "Fields" }, { "name": "include", "in": "query", "schema": { "type": "string" }, "required": false, "title": "Include" }, { "name": "meta", "in": "query", "schema": { "type": "boolean" }, "required": false, "title": "Meta" }, { "name": "hints", "in": "query", "schema": { "type": "boolean" }, "required": false, "title": "Hints" } ], "responses": { "200": { "description": "List of all cost components", "content": { "application/json": { "schema": { "oneOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/CostComponent" } }, { "$ref": "#/components/schemas/SearchResponse" } ] } } } } }, "x-permission": "settings.view" }, "post": { "summary": "Create new cost component", "tags": [ "Cost_Catalog" ], "parameters": [], "requestBody": { "description": "Cost component details", "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "oneOf": [ { "const": "material" }, { "const": "labor" }, { "const": "overhead" } ] }, "unit": { "type": "string" }, "rate": { "type": "number" }, "id": { "type": "string" }, "storeId": { "type": "string" }, "updatedAt": { "type": "string", "format": "date-time" }, "createdAt": { "type": "string", "format": "date-time" }, "description": { "oneOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": [ "name", "type", "unit", "rate" ] } } }, "required": true }, "responses": { "201": { "description": "The created cost component", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CostComponent" } } } } }, "x-permission": "settings.edit" } }, "/v1/cost-components/search": { "post": { "summary": "Search cost components", "description": "Search cost components with complex filters", "tags": [ "Cost_Catalog" ], "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchQueryDtoCostComponent" } } }, "required": true }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchResponse" } } } } }, "x-permission": "settings.view" } }, "/v1/cost-components/{id}": { "get": { "summary": "Get cost component by ID", "tags": [ "Cost_Catalog" ], "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true, "description": " Cost component ID" } ], "responses": { "200": { "description": "The requested cost component", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CostComponent" } } } } }, "x-permission": "settings.view" }, "patch": { "summary": "Update cost component", "tags": [ "Cost_Catalog" ], "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true, "description": " Cost component ID" } ], "requestBody": { "description": "Fields to update", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Partial__type.o12" } } }, "required": true }, "responses": { "200": { "description": "The updated cost component", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CostComponent" } } } } }, "x-permission": "settings.edit" }, "delete": { "summary": "Delete cost component", "tags": [ "Cost_Catalog" ], "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true, "description": " Cost component ID" } ], "responses": { "200": { "description": "Deleted IDs", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } } }, "x-permission": "settings.edit" } }, "/v1/sku-costs": { "get": { "summary": "Get all SKU costs for a store", "tags": [ "SKU_Costs" ], "parameters": [ { "name": "id", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "skuId", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "costComponentId", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "quantity", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "storeId", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "createdAt", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "updatedAt", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "sort", "in": "query", "schema": { "type": "string" }, "required": false, "title": "Sort" }, { "name": "limit", "in": "query", "schema": { "type": "number", "minimum": 1, "maximum": 1000 }, "required": false, "title": "Limit" }, { "name": "offset", "in": "query", "schema": { "type": "number", "minimum": 0 }, "required": false, "title": "Offset" }, { "name": "fields", "in": "query", "schema": { "type": "string" }, "required": false, "title": "Fields" }, { "name": "include", "in": "query", "schema": { "type": "string" }, "required": false, "title": "Include" }, { "name": "meta", "in": "query", "schema": { "type": "boolean" }, "required": false, "title": "Meta" }, { "name": "hints", "in": "query", "schema": { "type": "boolean" }, "required": false, "title": "Hints" } ], "responses": { "200": { "description": "List of SKU costs", "content": { "application/json": { "schema": { "oneOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/SkuCost" } }, { "$ref": "#/components/schemas/SearchResponse" } ] } } } } }, "x-permission": "sku.view" }, "post": { "summary": "Create a new SKU cost", "tags": [ "SKU_Costs" ], "parameters": [], "requestBody": { "description": "- SKU cost data", "content": { "application/json": { "schema": { "type": "object", "properties": { "skuId": { "type": "string" }, "costComponentId": { "type": "string" }, "id": { "type": "string" }, "storeId": { "type": "string" }, "updatedAt": { "type": "string", "format": "date-time" }, "createdAt": { "type": "string", "format": "date-time" }, "quantity": { "type": "number" } }, "required": [ "skuId", "costComponentId" ] } } }, "required": true }, "responses": { "201": { "description": "Created SKU cost", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SkuCost" } } } } }, "x-permission": "sku.edit" } }, "/v1/sku-costs/search": { "post": { "summary": "Search SKU costs", "description": "Search SKU costs with complex filters", "tags": [ "SKU_Costs" ], "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchQueryDtoSkuCost" } } }, "required": true }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchResponse" } } } } }, "x-permission": "sku.view" } }, "/v1/sku-costs/{id}": { "get": { "summary": "Get a specific SKU cost by ID", "tags": [ "SKU_Costs" ], "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true, "description": " - SKU cost identifier" } ], "responses": { "200": { "description": "SKU cost details", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SkuCost" } } } } }, "x-permission": "sku.view" }, "patch": { "summary": "Update a SKU cost", "tags": [ "SKU_Costs" ], "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true, "description": " - SKU cost identifier" } ], "requestBody": { "description": "- Updated SKU cost data", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Partial__type.o13" } } }, "required": true }, "responses": { "200": { "description": "Updated SKU cost", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SkuCost" } } } } }, "x-permission": "sku.edit" }, "delete": { "summary": "Delete a SKU cost", "tags": [ "SKU_Costs" ], "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true, "description": " - SKU cost identifier" } ], "responses": { "200": { "description": "Success status", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" } }, "required": [ "success" ] } } } } }, "x-permission": "sku.edit" } }, "/v1/sku-costs/by-sku/{skuId}": { "get": { "summary": "Get all costs for a specific SKU", "tags": [ "SKU_Costs" ], "parameters": [ { "name": "skuId", "in": "path", "schema": { "type": "string" }, "required": true, "description": " - SKU identifier" } ], "responses": { "200": { "description": "List of costs with component details for the SKU", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SkuCostWithComponent" } } } } } }, "x-permission": "sku.view" }, "delete": { "summary": "Delete all costs for a specific SKU", "tags": [ "SKU_Costs" ], "parameters": [ { "name": "skuId", "in": "path", "schema": { "type": "string" }, "required": true, "description": " - SKU identifier" } ], "responses": { "200": { "description": "Success status", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" } }, "required": [ "success" ] } } } } }, "x-permission": "sku.edit" } }, "/v1/sku-costs/breakdown/{skuId}": { "get": { "summary": "Get cost breakdown for a specific SKU", "tags": [ "SKU_Costs" ], "parameters": [ { "name": "skuId", "in": "path", "schema": { "type": "string" }, "required": true, "description": " - SKU identifier" } ], "responses": { "200": { "description": "Detailed breakdown of all costs for the SKU", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CostBreakdown" } } } } }, "x-permission": "sku.view" } }, "/v1/hints": { "get": { "summary": "Get path schema", "description": "Get schema for an API endpoint\n\nReturns request/response schemas for the specified API path,\nincluding parameters, request body, and response types.", "tags": [ "Hints" ], "parameters": [ { "name": "0", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/object" } } } } } } }, "/v1/hints/schema/types": { "get": { "summary": "List available types", "description": "List available type schemas\n\nReturns the names of all data types that have schemas available.", "tags": [ "Hints" ], "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } } } } }, "/v1/hints/schema/types/{typeName}": { "get": { "summary": "Get type schema", "description": "Get JSON schema for a data type\n\nReturns the full JSON schema for the specified data type,\nuseful for LLM introspection. Resolves $refs for readability.", "tags": [ "Hints" ], "parameters": [ { "name": "typeName", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/object" } } } } } } }, "/v1/hints/schema/paths": { "get": { "summary": "List available paths", "description": "List available API paths\n\nReturns all API endpoint paths that have schema definitions.", "tags": [ "Hints" ], "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } } } } }, "/v1/audit-logs": { "get": { "tags": [ "Audit_Logs" ], "parameters": [ { "name": "source", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "metadata", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "id", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "storeId", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "createdAt", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "entityType", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "entityId", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "entityIds", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "action", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "detailedAction", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "changes", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "actorId", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "actorType", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "actorEmail", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "apiKeyId", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "impersonatedBy", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "correlationId", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "ipAddress", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "userAgent", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "reason", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "sort", "in": "query", "schema": { "type": "string" }, "required": false, "title": "Sort" }, { "name": "limit", "in": "query", "schema": { "type": "number", "minimum": 1, "maximum": 1000 }, "required": false, "title": "Limit" }, { "name": "offset", "in": "query", "schema": { "type": "number", "minimum": 0 }, "required": false, "title": "Offset" }, { "name": "fields", "in": "query", "schema": { "type": "string" }, "required": false, "title": "Fields" }, { "name": "include", "in": "query", "schema": { "type": "string" }, "required": false, "title": "Include" }, { "name": "meta", "in": "query", "schema": { "type": "boolean" }, "required": false, "title": "Meta" }, { "name": "hints", "in": "query", "schema": { "type": "boolean" }, "required": false, "title": "Hints" }, { "name": "entityIdSearch", "in": "query", "schema": { "type": "string" }, "required": false } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "oneOf": [ { "type": "array", "items": { "type": "object", "properties": { "source": { "oneOf": [ { "const": "webhook" }, { "const": "system" }, { "const": "scheduler" }, { "const": "web" }, { "const": "api" }, { "const": "cli" } ] }, "metadata": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/Recordstringunknown" } ] }, "id": { "type": "string" }, "storeId": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "entityType": { "type": "string" }, "entityId": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "entityIds": { "oneOf": [ { "type": "null" }, { "type": "array", "items": { "type": "string" } } ] }, "action": { "oneOf": [ { "type": "null" }, { "const": "create" }, { "const": "update" }, { "const": "delete" }, { "const": "bulk_create" }, { "const": "bulk_update" }, { "const": "bulk_delete" }, { "const": "login" }, { "const": "logout" }, { "const": "export" }, { "const": "import" }, { "const": "sensitive_access" } ] }, "detailedAction": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "changes": { "oneOf": [ { "type": "null" }, { "type": "array", "items": { "$ref": "#/components/schemas/FieldChange" } } ] }, "actorId": { "type": "string" }, "actorType": { "oneOf": [ { "const": "user" }, { "const": "api_key" }, { "const": "webhook" }, { "const": "system" }, { "const": "scheduler" }, { "const": "fuse" } ] }, "actorEmail": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "apiKeyId": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "impersonatedBy": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "correlationId": { "type": "string" }, "ipAddress": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "userAgent": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "reason": { "oneOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": [ "source", "metadata", "id", "storeId", "createdAt", "entityType", "entityId", "entityIds", "action", "detailedAction", "changes", "actorId", "actorType", "actorEmail", "apiKeyId", "impersonatedBy", "correlationId", "ipAddress", "userAgent", "reason" ] } }, { "$ref": "#/components/schemas/SearchResponse" } ] } } } } } } }, "/v1/audit-logs/search": { "post": { "tags": [ "Audit_Logs" ], "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchQueryDto__type" } } }, "required": true }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchResponse" } } } } } } }, "/v1/settings/user": { "get": { "summary": "Get user settings", "tags": [ "Settings" ], "parameters": [], "responses": { "200": { "description": "Current user settings", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetUserSettingsResponse" } } } } } }, "patch": { "summary": "Update user settings", "tags": [ "Settings" ], "parameters": [], "requestBody": { "description": "Settings to update", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateUserSettingsRequest" } } }, "required": true }, "responses": { "200": { "description": "Updated user settings", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetUserSettingsResponse" } } } } } } }, "/v1/maintenance/items": { "get": { "summary": "List maintenance items", "description": "List all maintenance items for the store", "tags": [ "Maintenance" ], "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MaintenanceItem" } } } } } }, "x-permission": "maintenance.view" }, "post": { "summary": "Create maintenance item", "description": "Create a new maintenance item", "tags": [ "Maintenance" ], "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MaintenanceItemInsert" } } }, "required": true }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MaintenanceItem" } } } } }, "x-permission": "maintenance.create" } }, "/v1/maintenance/items/{id}": { "patch": { "summary": "Update maintenance item", "description": "Update a maintenance item", "tags": [ "Maintenance" ], "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartialPickMaintenanceItemnametriggerTypeintervalwarningThresholdPctnotes" } } }, "required": true }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MaintenanceItem" } } } } }, "x-permission": "maintenance.edit" }, "delete": { "summary": "Delete maintenance item", "description": "Delete a maintenance item", "tags": [ "Maintenance" ], "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "", "content": { "application/json": {} } } }, "x-permission": "maintenance.delete" } }, "/v1/maintenance/items/{id}/duplicate": { "post": { "summary": "Duplicate maintenance item", "description": "Duplicate a maintenance item", "tags": [ "Maintenance" ], "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MaintenanceItem" } } } } }, "x-permission": "maintenance.create" } }, "/v1/maintenance/fleet-status": { "get": { "summary": "Get fleet maintenance status", "description": "Get maintenance status for all enrolled printers", "tags": [ "Maintenance" ], "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MaintenanceStatusInfo" } } } } } }, "x-permission": "maintenance.view" } }, "/v1/maintenance/enrollments": { "get": { "summary": "List enrollments", "description": "List all maintenance enrollments for the store", "tags": [ "Maintenance" ], "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PrinterMaintenanceEnrollment" } } } } } }, "x-permission": "maintenance.view" }, "post": { "summary": "Enroll printers", "description": "Enroll printers in a maintenance item", "tags": [ "Maintenance" ], "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "maintenanceItemId": { "type": "string" }, "enrollments": { "type": "array", "items": { "type": "object", "properties": { "printerId": { "type": "string" }, "currentOffset": { "type": "number" } }, "required": [ "printerId" ] } } }, "required": [ "maintenanceItemId", "enrollments" ] } } }, "required": true }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PrinterMaintenanceEnrollment" } } } } } }, "x-permission": "maintenance.edit" }, "delete": { "summary": "Unenroll printers", "description": "Unenroll printers from maintenance items", "tags": [ "Maintenance" ], "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "enrollmentIds": { "type": "array", "items": { "type": "string" } } }, "required": [ "enrollmentIds" ] } } }, "required": true }, "responses": { "200": { "description": "", "content": { "application/json": {} } } }, "x-permission": "maintenance.edit" } }, "/v1/maintenance/printers/{printerId}/status": { "get": { "summary": "Get printer maintenance status", "description": "Get maintenance enrollments and status for a specific printer", "tags": [ "Maintenance" ], "parameters": [ { "name": "printerId", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MaintenanceStatusInfo" } } } } } }, "x-permission": "maintenance.view" } }, "/v1/maintenance/mark-done": { "post": { "summary": "Mark maintenance done", "description": "Mark maintenance as done for one or more enrollments", "tags": [ "Maintenance" ], "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "enrollmentIds": { "type": "array", "items": { "type": "string" } }, "notes": { "type": "string" }, "userId": { "type": "string" } }, "required": [ "enrollmentIds" ] } } }, "required": true }, "responses": { "201": { "description": "", "content": { "application/json": {} } } }, "x-permission": "maintenance.complete" } }, "/v1/maintenance/history": { "get": { "summary": "Get completion history", "description": "Get maintenance completion history", "tags": [ "Maintenance" ], "parameters": [ { "name": "printerId", "in": "query", "schema": { "type": "string" }, "required": false } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MaintenanceCompletionLog" } } } } } }, "x-permission": "maintenance.view" } }, "/v1/maintenance/recommended-profiles": { "get": { "summary": "Get recommended maintenance profiles", "description": "Get the recommended maintenance profile mapping (item name -> model codes).\nGlobal reference data, not per-store.", "tags": [ "Maintenance" ], "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecordstringArraystring" } } } } }, "x-permission": "maintenance.view" } }, "/v1/maintenance/recommended-enrollments": { "post": { "summary": "Enroll recommended maintenance", "description": "Enroll printers in recommended maintenance plans based on their model", "tags": [ "Maintenance" ], "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "printerIds": { "type": "array", "items": { "type": "string" } }, "offsets": { "$ref": "#/components/schemas/RecordstringRecordstringnumber" } }, "required": [ "printerIds", "offsets" ] } } }, "required": true }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "enrolledCount": { "type": "number" } }, "required": [ "enrolledCount" ] } } } } }, "x-permission": "maintenance.edit" } }, "/v1/maintenance/mode": { "patch": { "summary": "Set maintenance mode", "description": "Toggle maintenance mode on or off for one or more printers.\nEntitlement is checked inside the service only when enabling,\nso users can always turn maintenance mode off.", "tags": [ "Maintenance" ], "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "printerIds": { "type": "array", "items": { "type": "string" } }, "enabled": { "type": "boolean" } }, "required": [ "printerIds", "enabled" ] } } }, "required": true }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Printer" } } } } } }, "x-permission": "maintenance.edit" } }, "/v1/api-keys": { "get": { "summary": "Get all API keys", "description": "List all API keys for your store with optional search/filter", "tags": [ "API_Keys" ], "operationId": "apiKeys_getAll", "parameters": [ { "name": "hash", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "salt", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "name", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "active", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "managed", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "managedBy", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "externalRef", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "integrationId", "in": "query", "schema": { "type": "string" }, "required": false, "description": "Optional link to integration - when integration is deleted, this API key is also deleted" }, { "name": "fullAccess", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "ipAllowlist", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "createdBy", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "lastUsedAt", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "expiresAt", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "id", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "storeId", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "createdAt", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "updatedAt", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "sort", "in": "query", "schema": { "type": "string" }, "required": false, "title": "Sort" }, { "name": "limit", "in": "query", "schema": { "type": "number", "minimum": 1, "maximum": 1000 }, "required": false, "title": "Limit" }, { "name": "offset", "in": "query", "schema": { "type": "number", "minimum": 0 }, "required": false, "title": "Offset" }, { "name": "fields", "in": "query", "schema": { "type": "string" }, "required": false, "title": "Fields" }, { "name": "include", "in": "query", "schema": { "type": "string" }, "required": false, "title": "Include" }, { "name": "meta", "in": "query", "schema": { "type": "boolean" }, "required": false, "title": "Meta" }, { "name": "hints", "in": "query", "schema": { "type": "boolean" }, "required": false, "title": "Hints" } ], "responses": { "200": { "description": "All API keys (secrets are masked)", "content": { "application/json": { "schema": { "oneOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/ApiKey" } }, { "$ref": "#/components/schemas/SearchResponse" } ] } } } } }, "x-permission": "apiKey.view" }, "post": { "summary": "Create an API key", "description": "Generate a new API key. The full key is only returned once on creation.", "tags": [ "API_Keys" ], "parameters": [], "requestBody": { "description": "API key configuration", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateApiKeyRequest" } } }, "required": true }, "responses": { "201": { "description": "The created API key with full secret (one-time only)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OneTimeApiKeyInfo" } } } } }, "x-permission": "apiKey.create" } }, "/v1/api-keys/search": { "post": { "summary": "Search API keys", "description": "Advanced search for API keys", "tags": [ "API_Keys" ], "operationId": "apiKeys_search", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchQueryDtoApiKey" } } }, "required": true }, "responses": { "201": { "description": "Search results with API keys (secrets are masked)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchResponse" } } } } }, "x-permission": "apiKey.view" } }, "/v1/api-keys/{id}": { "get": { "summary": "Get API key by ID", "description": "Get a single API key by ID", "tags": [ "API_Keys" ], "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true, "description": " The API key's unique identifier" } ], "responses": { "200": { "description": "The requested API key (secret is masked)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiKey" } } } } }, "x-permission": "apiKey.view" }, "patch": { "summary": "Update an API key", "description": "Update an API key's configuration including name, status, permissions, roles, and IP restrictions", "tags": [ "API_Keys" ], "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true, "description": " The API key's unique identifier" } ], "requestBody": { "description": "Fields to update", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateApiKeyRequest" } } }, "required": true }, "responses": { "200": { "description": "The updated API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiKey" } } } } }, "x-permission": "apiKey.edit" }, "delete": { "summary": "Delete an API key", "description": "Permanently revoke an API key", "tags": [ "API_Keys" ], "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true, "description": " The API key's unique identifier" } ], "responses": { "200": { "description": "", "content": { "application/json": {} } } }, "x-permission": "apiKey.delete" } }, "/v1/api-keys/{id}/permissions": { "get": { "summary": "Get API key permissions", "description": "Get direct permissions for an API key", "tags": [ "API_Keys" ], "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true, "description": " The API key's unique identifier" } ], "responses": { "200": { "description": "List of permission types directly assigned to the API key", "content": { "application/json": { "schema": { "type": "array", "items": { "oneOf": [ { "const": "organization.owner" }, { "const": "organization.edit" }, { "const": "organization.delete" }, { "const": "user.view" }, { "const": "user.invite" }, { "const": "user.edit" }, { "const": "user.delete" }, { "const": "permission.view" }, { "const": "permission.grant" }, { "const": "permission.revoke" }, { "const": "part.view" }, { "const": "part.create" }, { "const": "part.edit" }, { "const": "part.delete" }, { "const": "part.export" }, { "const": "sku.view" }, { "const": "sku.create" }, { "const": "sku.edit" }, { "const": "sku.delete" }, { "const": "material.view" }, { "const": "material.create" }, { "const": "material.edit" }, { "const": "material.delete" }, { "const": "material.instance.view" }, { "const": "material.instance.create" }, { "const": "material.instance.edit" }, { "const": "material.instance.delete" }, { "const": "printer.view" }, { "const": "printer.create" }, { "const": "printer.edit" }, { "const": "printer.delete" }, { "const": "printer.control" }, { "const": "printer.ready" }, { "const": "printer.config" }, { "const": "printer.stats" }, { "const": "printer.camera" }, { "const": "profile.view" }, { "const": "profile.create" }, { "const": "profile.edit" }, { "const": "profile.delete" }, { "const": "queue.view" }, { "const": "queue.manage" }, { "const": "queue.override" }, { "const": "job.create" }, { "const": "job.edit.own" }, { "const": "job.edit.all" }, { "const": "job.delete.own" }, { "const": "job.delete.all" }, { "const": "build.view" }, { "const": "build.create" }, { "const": "build.edit" }, { "const": "build.delete" }, { "const": "settings.view" }, { "const": "settings.edit" }, { "const": "integration.view" }, { "const": "integration.manage" }, { "const": "subscription.view" }, { "const": "subscription.manage" }, { "const": "analytics.view" }, { "const": "reports.generate" }, { "const": "audit.log.view" }, { "const": "audit.logs.configure" }, { "const": "order.view" }, { "const": "order.create" }, { "const": "order.edit" }, { "const": "order.delete" }, { "const": "order.print" }, { "const": "apiKey.view" }, { "const": "apiKey.create" }, { "const": "apiKey.edit" }, { "const": "apiKey.delete" }, { "const": "file.download" }, { "const": "maintenance.view" }, { "const": "maintenance.create" }, { "const": "maintenance.edit" }, { "const": "maintenance.delete" }, { "const": "maintenance.complete" }, { "const": "internal.shopify" }, { "const": "queue.admin" }, { "const": "part.viewer" }, { "const": "part.editor" }, { "const": "sku.viewer" }, { "const": "sku.editor" }, { "const": "orders.admin" }, { "const": "material.viewer" }, { "const": "material.editor" }, { "const": "printer.viewer" }, { "const": "printer.editor" }, { "const": "profile.viewer" }, { "const": "profile.editor" }, { "const": "settings.admin" }, { "const": "subscription.admin" } ] } } } } } }, "x-permission": "apiKey.view" } }, "/v1/api-keys/{id}/roles": { "get": { "summary": "Get API key roles", "description": "Get assigned role IDs for an API key", "tags": [ "API_Keys" ], "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true, "description": " The API key's unique identifier" } ], "responses": { "200": { "description": "List of role IDs assigned to the API key", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } } }, "x-permission": "apiKey.view" } }, "/v1/subscriptions": { "get": { "summary": "Get current subscription", "tags": [ "Subscriptions" ], "parameters": [], "responses": { "200": { "description": "The store's subscription details", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Subscription" } } } } }, "x-permission": "subscription.view" } }, "/v1/subscriptions/audit-logs": { "patch": { "summary": "Configure audit logs", "description": "Enable or disable audit logging", "tags": [ "Subscriptions" ], "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetAuditLogsEnabledRequest" } } }, "required": true }, "responses": { "200": { "description": "The current subscription", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Subscription" } } } } }, "x-permission": "audit.logs.configure" } }, "/v1/subscriptions/search": { "post": { "summary": "Search subscriptions", "description": "Advanced search for subscriptions", "tags": [ "Subscriptions" ], "operationId": "subscriptions_search", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchQueryDtoSubscription" } } }, "required": true }, "responses": { "201": { "description": "Search results with subscriptions", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchResponse" } } } } }, "x-permission": "subscription.view" } }, "/v1/addons": { "get": { "summary": "Get all available addons", "tags": [ "Subscriptions" ], "parameters": [], "responses": { "200": { "description": "List of all addons", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Addon" } } } } } } } }, "/v1/addons/{addonType}": { "get": { "summary": "Get addon by type with tiers", "tags": [ "Subscriptions" ], "parameters": [ { "name": "addonType", "in": "path", "schema": { "type": "string" }, "required": true, "description": " The addon type identifier" } ], "responses": { "200": { "description": "The addon with its pricing tiers", "content": { "application/json": { "schema": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/AddonWithTiers" } ] } } } } } } }, "/v1/addon-subscriptions": { "get": { "summary": "Get all addon subscriptions", "tags": [ "Subscriptions" ], "parameters": [ { "name": "addonType", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "tierKey", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "tierId", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "term", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "id", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "storeId", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "createdAt", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "updatedAt", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "sort", "in": "query", "schema": { "type": "string" }, "required": false, "title": "Sort" }, { "name": "limit", "in": "query", "schema": { "type": "number", "minimum": 1, "maximum": 1000 }, "required": false, "title": "Limit" }, { "name": "offset", "in": "query", "schema": { "type": "number", "minimum": 0 }, "required": false, "title": "Offset" }, { "name": "fields", "in": "query", "schema": { "type": "string" }, "required": false, "title": "Fields" }, { "name": "include", "in": "query", "schema": { "type": "string" }, "required": false, "title": "Include" }, { "name": "meta", "in": "query", "schema": { "type": "boolean" }, "required": false, "title": "Meta" }, { "name": "hints", "in": "query", "schema": { "type": "boolean" }, "required": false, "title": "Hints" } ], "responses": { "200": { "description": "List of addon subscriptions for the store", "content": { "application/json": { "schema": { "oneOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/AddonSubscription" } }, { "$ref": "#/components/schemas/SearchResponse" } ] } } } } }, "x-permission": "subscription.view" } }, "/v1/addon-subscriptions/{addonType}": { "get": { "summary": "Get addon subscription by type", "tags": [ "Subscriptions" ], "parameters": [ { "name": "addonType", "in": "path", "schema": { "type": "string" }, "required": true, "description": " The addon type identifier" } ], "responses": { "200": { "description": "The addon subscription if found", "content": { "application/json": { "schema": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/AddonSubscription" } ] } } } } }, "x-permission": "subscription.view" } }, "/v1/addon-subscriptions/search": { "post": { "summary": "Search addon subscriptions", "description": "Advanced search for addon subscriptions", "tags": [ "Subscriptions" ], "operationId": "addonSubscriptions_search", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchQueryDtoAddonSubscription" } } }, "required": true }, "responses": { "201": { "description": "Search results with addon subscriptions", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchResponse" } } } } }, "x-permission": "subscription.view" } }, "/v1/storage/signed-urls": { "post": { "summary": "Get signed download URLs", "tags": [ "Files" ], "parameters": [], "requestBody": { "description": "File paths to generate URLs for", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SignedUrlsRequest" } } }, "required": true }, "responses": { "201": { "description": "Signed URLs for downloading files", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SignedUrlsResponse" } } } } }, "x-permission": "file.download" } }, "/v1/storage/signed-upload-urls": { "post": { "summary": "Get signed upload URLs", "tags": [ "Files" ], "parameters": [], "requestBody": { "description": "File details for upload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SignedUploadUrlsRequest" } } }, "required": true }, "responses": { "201": { "description": "Signed URLs for uploading files", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SignedUploadUrlsResponse" } } } } }, "x-permission": "part.create" } }, "/v1/orders": { "get": { "summary": "Get all orders", "tags": [ "Orders" ], "parameters": [ { "name": "orderNumber", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "source", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "status", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "cancelledAt", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "customerId", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "integrationId", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "priceBucket", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "price", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "currency", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "externalId", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "externalUrl", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "sourceRef", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "note", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "deadline", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "processedAt", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "syncDisabled", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "id", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "storeId", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "createdAt", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "updatedAt", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "sort", "in": "query", "schema": { "type": "string" }, "required": false, "title": "Sort" }, { "name": "limit", "in": "query", "schema": { "type": "number", "minimum": 1, "maximum": 1000 }, "required": false, "title": "Limit" }, { "name": "offset", "in": "query", "schema": { "type": "number", "minimum": 0 }, "required": false, "title": "Offset" }, { "name": "fields", "in": "query", "schema": { "type": "string" }, "required": false, "title": "Fields" }, { "name": "include", "in": "query", "schema": { "type": "string" }, "required": false, "title": "Include" }, { "name": "meta", "in": "query", "schema": { "type": "boolean" }, "required": false, "title": "Meta" }, { "name": "hints", "in": "query", "schema": { "type": "boolean" }, "required": false, "title": "Hints" } ], "responses": { "200": { "description": "List of all orders for the current store", "content": { "application/json": { "schema": { "oneOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/Order" } }, { "$ref": "#/components/schemas/SearchResponse" } ] } } } } }, "x-permission": "order.view" }, "post": { "summary": "Create a new order", "tags": [ "Orders" ], "parameters": [], "requestBody": { "description": "Order details including optional customer and items", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateOrderDto" } } }, "required": true }, "responses": { "201": { "description": "Complete order details with customer and items", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderDetailsResponse" } } } } }, "x-permission": "order.create" } }, "/v1/orders/full": { "get": { "summary": "Get complete order data", "tags": [ "Orders" ], "parameters": [], "responses": { "200": { "description": "All orders with their items and customer information in a single response", "content": { "application/json": { "schema": { "type": "object", "properties": { "orders": { "type": "array", "items": { "$ref": "#/components/schemas/Order" } }, "orderItems": { "type": "array", "items": { "$ref": "#/components/schemas/OrderItem" } }, "customers": { "type": "array", "items": { "$ref": "#/components/schemas/Customer" } } }, "required": [ "orders", "orderItems", "customers" ] } } } } }, "x-permission": "order.view" } }, "/v1/orders/items": { "get": { "summary": "Get all order items", "tags": [ "Order_Items" ], "parameters": [], "responses": { "200": { "description": "List of all order items across all orders in the store", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OrderItem" } } } } } }, "x-permission": "order.view" } }, "/v1/orders/ignored-skus": { "get": { "summary": "Get ignored SKUs list", "tags": [ "Orders" ], "parameters": [], "responses": { "200": { "description": "The current list of SKUs that should be ignored during order processing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IgnoredSku" } } } } }, "x-permission": "order.view" }, "patch": { "summary": "Update ignored SKUs list", "tags": [ "Orders" ], "parameters": [], "requestBody": { "description": "SKUs to add to or remove from the ignore list", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EditIgnoredSkusRequest" } } }, "required": true }, "responses": { "200": { "description": "Updated list of ignored SKUs", "content": { "application/json": { "schema": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/IgnoredSku" } ] } } } } }, "x-permission": "order.edit" } }, "/v1/orders/ignored-skus/check": { "post": { "summary": "Check if SKUs are ignored", "tags": [ "Orders" ], "parameters": [], "requestBody": { "description": "List of SKUs to check", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CheckIgnoredSkusRequest" } } }, "required": true }, "responses": { "201": { "description": "Object mapping each SKU to a boolean indicating if it's ignored", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CheckIgnoredSkusResponse" } } } } }, "x-permission": "order.view" } }, "/v1/orders/reconcile": { "post": { "summary": "Reconcile print jobs with orders", "tags": [ "Orders" ], "parameters": [], "requestBody": { "description": "Reconciliation parameters including SKUs, orders, printer tags, and priority", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReconcileJobsRequest" } } }, "required": true }, "responses": { "201": { "description": "Results of the reconciliation process", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReconcileJobsResponse" } } } } }, "x-permission": "order.print" } }, "/v1/orders/print": { "post": { "summary": "Reconcile print jobs with orders", "tags": [ "Orders" ], "parameters": [], "requestBody": { "description": "Reconciliation parameters including SKUs, orders, printer tags, and priority", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReconcileJobsRequest" } } }, "required": true }, "responses": { "201": { "description": "Results of the reconciliation process", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReconcileJobsResponse" } } } } }, "x-permission": "order.print" } }, "/v1/orders/batch/close": { "patch": { "summary": "Batch close orders", "tags": [ "Orders" ], "parameters": [], "requestBody": { "description": "Order IDs to close", "content": { "application/json": { "schema": { "type": "object", "properties": { "orderIds": { "type": "array", "items": { "type": "string", "pattern": "^[a-z0-9]{24}$" } } }, "required": [ "orderIds" ] } } }, "required": true }, "responses": { "200": { "description": "Results of the batch close operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "closed": { "type": "array", "items": { "$ref": "#/components/schemas/Order" } }, "errors": { "type": "array", "items": { "type": "object", "properties": { "orderId": { "type": "string" }, "error": { "type": "string" } }, "required": [ "orderId", "error" ] } } }, "required": [ "closed", "errors" ] } } } } }, "x-permission": "order.edit" } }, "/v1/orders/batch/reopen": { "patch": { "summary": "Batch reopen orders", "tags": [ "Orders" ], "parameters": [], "requestBody": { "description": "Order IDs to reopen", "content": { "application/json": { "schema": { "type": "object", "properties": { "orderIds": { "type": "array", "items": { "type": "string", "pattern": "^[a-z0-9]{24}$" } } }, "required": [ "orderIds" ] } } }, "required": true }, "responses": { "200": { "description": "Results of the batch reopen operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "reopened": { "type": "array", "items": { "$ref": "#/components/schemas/Order" } }, "errors": { "type": "array", "items": { "type": "object", "properties": { "orderId": { "type": "string" }, "error": { "type": "string" } }, "required": [ "orderId", "error" ] } } }, "required": [ "reopened", "errors" ] } } } } }, "x-permission": "order.edit" } }, "/v1/orders/batch/cancel": { "patch": { "summary": "Batch cancel orders", "tags": [ "Orders" ], "parameters": [], "requestBody": { "description": "Order IDs to cancel", "content": { "application/json": { "schema": { "type": "object", "properties": { "orderIds": { "type": "array", "items": { "type": "string", "pattern": "^[a-z0-9]{24}$" } } }, "required": [ "orderIds" ] } } }, "required": true }, "responses": { "200": { "description": "Results of the batch cancel operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "cancelled": { "type": "array", "items": { "$ref": "#/components/schemas/OrderDetailsResponse" } }, "errors": { "type": "array", "items": { "type": "object", "properties": { "orderId": { "type": "string" }, "error": { "type": "string" } }, "required": [ "orderId", "error" ] } } }, "required": [ "cancelled", "errors" ] } } } } }, "x-permission": "order.edit" } }, "/v1/orders/batch/delete": { "delete": { "summary": "Batch delete orders", "tags": [ "Orders" ], "parameters": [], "requestBody": { "description": "Order IDs to delete permanently", "content": { "application/json": { "schema": { "type": "object", "properties": { "orderIds": { "type": "array", "items": { "type": "string", "pattern": "^[a-z0-9]{24}$" } } }, "required": [ "orderIds" ] } } }, "required": true }, "responses": { "200": { "description": "Results of the batch delete operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "deleted": { "type": "array", "items": { "type": "string" } }, "errors": { "type": "array", "items": { "type": "object", "properties": { "orderId": { "type": "string" }, "error": { "type": "string" } }, "required": [ "orderId", "error" ] } } }, "required": [ "deleted", "errors" ] } } } } }, "x-permission": "order.delete" } }, "/v1/orders/customers": { "get": { "summary": "Get all customers", "tags": [ "Orders" ], "parameters": [], "responses": { "200": { "description": "List of all customers associated with orders in the store", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Customer" } } } } } }, "x-permission": "order.view" }, "post": { "summary": "Create a new customer", "tags": [ "Orders" ], "parameters": [], "requestBody": { "description": "Customer information (requires at least name, email, or phone)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateCustomerDto" } } }, "required": true }, "responses": { "201": { "description": "The created customer record", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Customer" } } } } }, "x-permission": "order.create" } }, "/v1/orders/customers/{customerId}": { "get": { "summary": "Get customer by ID", "tags": [ "Orders" ], "parameters": [ { "name": "customerId", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true, "description": " The customer's unique identifier" } ], "responses": { "200": { "description": "Customer information", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Customer" } } } } }, "x-permission": "order.view" } }, "/v1/orders/items/{itemId}": { "get": { "summary": "Get a specific order item", "tags": [ "Order_Items" ], "parameters": [ { "name": "itemId", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true, "description": " The order item's unique identifier" } ], "responses": { "200": { "description": "Order item details", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderItem" } } } } }, "x-permission": "order.view" }, "put": { "summary": "Update an order item", "tags": [ "Order_Items" ], "parameters": [ { "name": "itemId", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true, "description": " The order item's unique identifier" } ], "requestBody": { "description": "Fields to update on the order item", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartialOrderItemUpdate" } } }, "required": true }, "responses": { "200": { "description": "Updated order item", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderItem" } } } } }, "x-permission": "order.edit" }, "delete": { "summary": "Delete an order item", "tags": [ "Order_Items" ], "parameters": [ { "name": "itemId", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true, "description": " The order item's unique identifier" } ], "responses": { "200": { "description": "Confirmation with the deleted item's ID", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" } }, "required": [ "id" ] } } } } }, "x-permission": "order.delete" } }, "/v1/orders/by-external/{source}/{externalId}/jobs": { "get": { "summary": "Get print jobs for an external order", "tags": [ "Orders" ], "parameters": [ { "name": "source", "in": "path", "schema": { "oneOf": [ { "const": "etsy" }, { "const": "shopify" }, { "const": "manual" }, { "const": "ebay" }, { "const": "tiktok-shop" } ] }, "required": true, "description": " The order source (e.g., 'shopify', 'etsy')" }, { "name": "externalId", "in": "path", "schema": { "type": "string" }, "required": true, "description": " The external order ID from the source system" } ], "responses": { "200": { "description": "List of print jobs associated with the order", "content": { "application/json": { "schema": { "type": "object", "properties": { "orderId": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "jobs": { "type": "array", "items": { "$ref": "#/components/schemas/PrintJob" } } }, "required": [ "orderId", "jobs" ] } } } } }, "x-permission": "order.view" } }, "/v1/orders/{orderId}/items": { "get": { "summary": "Get items for a specific order", "tags": [ "Order_Items" ], "parameters": [ { "name": "orderId", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true, "description": " The order's unique identifier" } ], "responses": { "200": { "description": "List of items belonging to the order", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OrderItem" } } } } } }, "x-permission": "order.view" }, "post": { "summary": "Add items to an order", "tags": [ "Order_Items" ], "parameters": [ { "name": "orderId", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true, "description": " The order's unique identifier" } ], "requestBody": { "description": "Array of items to add to the order", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmitOrderItemInsertorderId" } } } }, "required": true }, "responses": { "201": { "description": "List of created order items", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OrderItem" } } } } } }, "x-permission": "order.edit" } }, "/v1/orders/{orderId}/items/batch": { "patch": { "summary": "Batch update order items", "tags": [ "Order_Items" ], "parameters": [ { "name": "orderId", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true, "description": " The order's unique identifier" } ], "requestBody": { "description": "Array of item updates with item IDs and changes", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "itemId": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "changes": { "$ref": "#/components/schemas/PartialOrderItemUpdate" } }, "required": [ "itemId", "changes" ] } } } }, "required": true }, "responses": { "200": { "description": "List of updated order items", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OrderItem" } } } } } }, "x-permission": "order.edit" } }, "/v1/orders/{orderId}/only": { "get": { "summary": "Get order without related data", "tags": [ "Orders" ], "parameters": [ { "name": "orderId", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true, "description": " The order's unique identifier" } ], "responses": { "200": { "description": "Order information without items or customer data", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order" } } } } }, "x-permission": "order.view" } }, "/v1/orders/{orderId}": { "get": { "summary": "Get order with full details", "tags": [ "Orders" ], "parameters": [ { "name": "orderId", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true, "description": " The order's unique identifier" } ], "responses": { "200": { "description": "Complete order information including customer and items", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderDetailsResponse" } } } } }, "x-permission": "order.view" }, "put": { "summary": "Update an order", "tags": [ "Orders" ], "parameters": [ { "name": "orderId", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true, "description": " The order's unique identifier" } ], "requestBody": { "description": "Fields to update on the order", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartialOrder" } } }, "required": true }, "responses": { "200": { "description": "Updated order information", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order" } } } } }, "x-permission": "order.edit" }, "delete": { "summary": "Delete an order", "tags": [ "Orders" ], "parameters": [ { "name": "orderId", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true, "description": " The order's unique identifier" } ], "responses": { "200": { "description": "Confirmation with the deleted order's ID", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" } }, "required": [ "id" ] } } } } }, "x-permission": "order.delete" } }, "/v1/orders/{orderId}/cancel": { "post": { "summary": "Cancel an order", "tags": [ "Orders" ], "parameters": [ { "name": "orderId", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true, "description": " The order's unique identifier" } ], "responses": { "201": { "description": "Cancelled order with updated items", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderDetailsResponse" } } } } }, "x-permission": "order.edit" } }, "/v1/orders/search": { "post": { "summary": "Search orders", "description": "Advanced search for orders", "tags": [ "Orders" ], "operationId": "orders_search", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchQueryDtoOrder" } } }, "required": true }, "responses": { "201": { "description": "Search results with orders", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchResponse" } } } } }, "x-permission": "order.view" } }, "/v1/order-items": { "get": { "summary": "Get all order items", "description": "List all order items across all orders in the store", "tags": [ "Order_Items" ], "operationId": "orderItems_getAll", "parameters": [ { "name": "orderId", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "skuId", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "source", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "quantity", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "inputs", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "status", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "externalId", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "externalOrderId", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "externalProductId", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "externalSku", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "originalSku", "in": "query", "schema": { "type": "string" }, "required": false, "description": "Original SKU identifier sent when creating the order item (sku or externalSku), null if skuId was provided directly" }, { "name": "processedAt", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "ignored", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "processedStatus", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "skuConfig", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "resolutionNote", "in": "query", "schema": { "type": "string" }, "required": false, "description": "Describes why SKU or variant resolution failed, null when resolved successfully" }, { "name": "id", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "storeId", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "createdAt", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "updatedAt", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "sort", "in": "query", "schema": { "type": "string" }, "required": false, "title": "Sort" }, { "name": "limit", "in": "query", "schema": { "type": "number", "minimum": 1, "maximum": 1000 }, "required": false, "title": "Limit" }, { "name": "offset", "in": "query", "schema": { "type": "number", "minimum": 0 }, "required": false, "title": "Offset" }, { "name": "fields", "in": "query", "schema": { "type": "string" }, "required": false, "title": "Fields" }, { "name": "include", "in": "query", "schema": { "type": "string" }, "required": false, "title": "Include" }, { "name": "meta", "in": "query", "schema": { "type": "boolean" }, "required": false, "title": "Meta" }, { "name": "hints", "in": "query", "schema": { "type": "boolean" }, "required": false, "title": "Hints" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "oneOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/OrderItem" } }, { "$ref": "#/components/schemas/SearchResponse" } ] } } } } }, "x-permission": "order.view" } }, "/v1/order-items/search": { "post": { "summary": "Search order items", "description": "Search order items with filters", "tags": [ "Order_Items" ], "operationId": "orderItems_search", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchQueryDtoOrderItem" } } }, "required": true }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchResponse" } } } } }, "x-permission": "order.view" } }, "/v1/customers": { "get": { "summary": "Get all customers", "description": "List all customers associated with orders in the store", "tags": [ "Customers" ], "operationId": "customers_getAll", "parameters": [ { "name": "name", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "email", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "phone", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "countryCode", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "provinceCode", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "zipCode", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "externalId", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "source", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "id", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "storeId", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "createdAt", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "updatedAt", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "sort", "in": "query", "schema": { "type": "string" }, "required": false, "title": "Sort" }, { "name": "limit", "in": "query", "schema": { "type": "number", "minimum": 1, "maximum": 1000 }, "required": false, "title": "Limit" }, { "name": "offset", "in": "query", "schema": { "type": "number", "minimum": 0 }, "required": false, "title": "Offset" }, { "name": "fields", "in": "query", "schema": { "type": "string" }, "required": false, "title": "Fields" }, { "name": "include", "in": "query", "schema": { "type": "string" }, "required": false, "title": "Include" }, { "name": "meta", "in": "query", "schema": { "type": "boolean" }, "required": false, "title": "Meta" }, { "name": "hints", "in": "query", "schema": { "type": "boolean" }, "required": false, "title": "Hints" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "oneOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/Customer" } }, { "$ref": "#/components/schemas/SearchResponse" } ] } } } } }, "x-permission": "order.view" } }, "/v1/customers/search": { "post": { "summary": "Search customers", "description": "Search customers with filters", "tags": [ "Customers" ], "operationId": "customers_search", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchQueryDtoCustomer" } } }, "required": true }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchResponse" } } } } }, "x-permission": "order.view" } }, "/v1/ignored-skus": { "get": { "summary": "Get all ignored SKUs", "description": "List all ignored SKUs that should be skipped during order processing", "tags": [ "Orders" ], "operationId": "ignoredSkus_getAll", "parameters": [ { "name": "skus", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "id", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "storeId", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "createdAt", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "updatedAt", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "sort", "in": "query", "schema": { "type": "string" }, "required": false, "title": "Sort" }, { "name": "limit", "in": "query", "schema": { "type": "number", "minimum": 1, "maximum": 1000 }, "required": false, "title": "Limit" }, { "name": "offset", "in": "query", "schema": { "type": "number", "minimum": 0 }, "required": false, "title": "Offset" }, { "name": "fields", "in": "query", "schema": { "type": "string" }, "required": false, "title": "Fields" }, { "name": "include", "in": "query", "schema": { "type": "string" }, "required": false, "title": "Include" }, { "name": "meta", "in": "query", "schema": { "type": "boolean" }, "required": false, "title": "Meta" }, { "name": "hints", "in": "query", "schema": { "type": "boolean" }, "required": false, "title": "Hints" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "oneOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/IgnoredSku" } }, { "$ref": "#/components/schemas/SearchResponse" } ] } } } } }, "x-permission": "order.view" } }, "/v1/ignored-skus/search": { "post": { "summary": "Search ignored SKUs", "description": "Search ignored SKUs with filters", "tags": [ "Orders" ], "operationId": "ignoredSkus_search", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchQueryDtoIgnoredSku" } } }, "required": true }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchResponse" } } } } }, "x-permission": "order.view" } }, "/v1/integrations/shopify": { "get": { "summary": "List Shopify integrations", "description": "List all connected Shopify stores for a store", "tags": [ "Shopify" ], "parameters": [], "responses": { "200": { "description": "Array of connected Shopify stores", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "integrationId": { "type": "string" }, "shop": { "type": "string" }, "shopName": { "type": "string" }, "connectedAt": { "type": "string", "format": "date-time" } }, "required": [ "integrationId", "shop", "shopName", "connectedAt" ] } } } } } }, "x-permission": "integration.view" } }, "/v1/integrations/shopify/{integrationId}/status": { "get": { "summary": "Get Shopify status", "description": "Get Shopify integration status", "tags": [ "Shopify" ], "parameters": [ { "name": "integrationId", "in": "path", "schema": { "type": "string" }, "required": true, "description": " The Shopify integration ID" } ], "responses": { "200": { "description": "Integration status", "content": { "application/json": { "schema": { "type": "object", "properties": { "connected": { "type": "boolean" }, "shop": { "type": "string" }, "connectedAt": { "type": "string", "format": "date-time" }, "lastSyncedAt": { "type": "string", "format": "date-time" } }, "required": [ "connected" ] } } } } }, "x-permission": "integration.view" } }, "/v1/integrations/shopify/{integrationId}/settings": { "get": { "summary": "Get Shopify settings", "description": "Get Shopify integration settings", "tags": [ "Shopify" ], "parameters": [ { "name": "integrationId", "in": "path", "schema": { "type": "string" }, "required": true, "description": " The Shopify integration ID" } ], "responses": { "200": { "description": "Integration settings", "content": { "application/json": { "schema": { "type": "object", "properties": { "autoPrint": { "type": "boolean" }, "writeProgressTags": { "type": "boolean" }, "autoCloseOrders": { "oneOf": [ { "const": "partial" }, { "const": "never" }, { "const": "fulfilled" } ] }, "tagWhenPrinted": { "type": "string" }, "propertyWhitelist": { "type": "array", "items": { "type": "string" } }, "ignoredVariantNames": { "type": "array", "items": { "type": "string" } } }, "required": [ "autoPrint", "writeProgressTags", "autoCloseOrders", "tagWhenPrinted", "propertyWhitelist", "ignoredVariantNames" ] } } } } }, "x-permission": "integration.view" }, "patch": { "summary": "Update Shopify settings", "description": "Update Shopify integration settings", "tags": [ "Shopify" ], "parameters": [ { "name": "integrationId", "in": "path", "schema": { "type": "string" }, "required": true, "description": " The Shopify integration ID" } ], "requestBody": { "description": "Settings to update", "content": { "application/json": { "schema": { "type": "object", "properties": { "autoPrint": { "type": "boolean" }, "writeProgressTags": { "type": "boolean" }, "autoCloseOrders": { "oneOf": [ { "const": "partial" }, { "const": "never" }, { "const": "fulfilled" } ] }, "tagWhenPrinted": { "type": "string" }, "propertyWhitelist": { "type": "array", "items": { "type": "string" } }, "ignoredVariantNames": { "type": "array", "items": { "type": "string" } } } } } }, "required": true }, "responses": { "200": { "description": "Updated settings", "content": { "application/json": { "schema": { "type": "object", "properties": { "autoPrint": { "type": "boolean" }, "writeProgressTags": { "type": "boolean" }, "autoCloseOrders": { "oneOf": [ { "const": "partial" }, { "const": "never" }, { "const": "fulfilled" } ] }, "tagWhenPrinted": { "type": "string" }, "propertyWhitelist": { "type": "array", "items": { "type": "string" } }, "ignoredVariantNames": { "type": "array", "items": { "type": "string" } } }, "required": [ "autoPrint", "writeProgressTags", "autoCloseOrders", "tagWhenPrinted", "propertyWhitelist", "ignoredVariantNames" ] } } } } }, "x-permission": "integration.manage" } }, "/v1/integrations/shopify/{integrationId}/disconnect": { "post": { "summary": "Disconnect Shopify", "description": "Disconnect Shopify integration", "tags": [ "Shopify" ], "parameters": [ { "name": "integrationId", "in": "path", "schema": { "type": "string" }, "required": true, "description": " The Shopify integration ID" } ], "responses": { "201": { "description": "Success message", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } } } }, "x-permission": "integration.manage" } }, "/v1/integrations/shopify/orders/{orderId}/retry-variant-enrichment": { "post": { "summary": "Retry variant enrichment", "description": "Retry fetching variant options from Shopify for order items\nthat failed during initial webhook processing.", "tags": [ "Shopify" ], "parameters": [ { "name": "orderId", "in": "path", "schema": { "type": "string" }, "required": true, "description": " The Printago order ID" } ], "responses": { "201": { "description": "Count of updated and failed items", "content": { "application/json": { "schema": { "type": "object", "properties": { "updated": { "type": "number" }, "failed": { "type": "number" } }, "required": [ "updated", "failed" ] } } } } }, "x-permission": "order.edit" } }, "/v1/integrations/etsy": { "get": { "summary": "List Etsy integrations", "description": "List all connected Etsy shops for a store", "tags": [ "Etsy" ], "parameters": [], "responses": { "200": { "description": "Array of connected Etsy shops", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "integrationId": { "type": "string" }, "shopId": { "type": "string" }, "shopName": { "type": "string" } }, "required": [ "integrationId", "shopId", "shopName" ] } } } } } }, "x-permission": "integration.view" } }, "/v1/integrations/etsy/{integrationId}/sync-orders": { "post": { "summary": "Sync Etsy orders", "description": "Manually sync orders from Etsy", "tags": [ "Etsy" ], "parameters": [ { "name": "integrationId", "in": "path", "schema": { "type": "string" }, "required": true, "description": " The Etsy integration ID" }, { "name": "includeShipped", "in": "query", "schema": { "type": "string" }, "description": " Include shipped orders (for testing)", "required": true }, { "name": "limit", "in": "query", "schema": { "type": "string" }, "description": " Number of orders to sync", "required": true } ], "responses": { "201": { "description": "Sync results", "content": { "application/json": { "schema": { "type": "object", "properties": { "orders": { "type": "array", "items": { "$ref": "#/components/schemas/Order" } }, "totalSynced": { "type": "number" }, "totalAvailable": { "type": "number" }, "skipped": { "type": "number" }, "limitReached": { "type": "boolean" } }, "required": [ "orders", "totalSynced", "totalAvailable", "skipped", "limitReached" ] } } } } }, "x-permission": "integration.manage" } }, "/v1/integrations/etsy/{integrationId}/status": { "get": { "summary": "Get Etsy status", "description": "Get Etsy integration status", "tags": [ "Etsy" ], "parameters": [ { "name": "integrationId", "in": "path", "schema": { "type": "string" }, "required": true, "description": " The Etsy integration ID" } ], "responses": { "200": { "description": "Integration status", "content": { "application/json": { "schema": { "type": "object", "properties": { "connected": { "type": "boolean" }, "shopId": { "type": "string" }, "shopName": { "type": "string" }, "shopUrl": { "type": "string" }, "lastSyncedAt": { "type": "string", "format": "date-time" } }, "required": [ "connected" ] } } } } }, "x-permission": "integration.view" } }, "/v1/integrations/etsy/{integrationId}/settings": { "get": { "summary": "Get Etsy settings", "description": "Get Etsy integration settings", "tags": [ "Etsy" ], "parameters": [ { "name": "integrationId", "in": "path", "schema": { "type": "string" }, "required": true, "description": " The Etsy integration ID" } ], "responses": { "200": { "description": "Integration settings", "content": { "application/json": { "schema": { "type": "object", "properties": { "autoPrint": { "type": "boolean" }, "autoCloseOrders": { "oneOf": [ { "const": "shipped" }, { "const": "delivered" }, { "const": "never" } ] }, "ignoredVariantNames": { "type": "array", "items": { "type": "string" } } }, "required": [ "autoPrint", "autoCloseOrders", "ignoredVariantNames" ] } } } } }, "x-permission": "integration.view" }, "patch": { "summary": "Update Etsy settings", "description": "Update Etsy integration settings", "tags": [ "Etsy" ], "parameters": [ { "name": "integrationId", "in": "path", "schema": { "type": "string" }, "required": true, "description": " The Etsy integration ID" } ], "requestBody": { "description": "Settings to update", "content": { "application/json": { "schema": { "type": "object", "properties": { "autoPrint": { "type": "boolean" }, "autoCloseOrders": { "oneOf": [ { "const": "shipped" }, { "const": "delivered" }, { "const": "never" } ] }, "ignoredVariantNames": { "type": "array", "items": { "type": "string" } } } } } }, "required": true }, "responses": { "200": { "description": "Updated settings", "content": { "application/json": { "schema": { "type": "object", "properties": { "autoPrint": { "type": "boolean" }, "autoCloseOrders": { "oneOf": [ { "const": "shipped" }, { "const": "delivered" }, { "const": "never" } ] }, "ignoredVariantNames": { "type": "array", "items": { "type": "string" } } }, "required": [ "autoPrint", "autoCloseOrders", "ignoredVariantNames" ] } } } } }, "x-permission": "integration.manage" } }, "/v1/integrations/etsy/{integrationId}/usage": { "get": { "summary": "Get Etsy usage stats", "description": "Get current usage statistics for the Etsy integration", "tags": [ "Etsy" ], "parameters": [ { "name": "integrationId", "in": "path", "schema": { "type": "string" }, "required": true, "description": " The Etsy integration ID" } ], "responses": { "200": { "description": "Usage stats including tier, limits, and cycle dates", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UsageStats.o1" } } } } }, "x-permission": "integration.view" } }, "/v1/integrations/etsy/{integrationId}/listing/{listingId}": { "get": { "summary": "Get Etsy listing", "description": "Fetch a single listing with inventory", "tags": [ "Etsy" ], "parameters": [ { "name": "integrationId", "in": "path", "schema": { "type": "string" }, "required": true, "description": " The Etsy integration ID" }, { "name": "listingId", "in": "path", "schema": { "type": "string" }, "required": true, "description": " The Etsy listing ID" } ], "responses": { "200": { "description": "Single listing with inventory details", "content": { "application/json": { "schema": {} } } } }, "x-permission": "integration.view" } }, "/v1/integrations/ebay": { "get": { "summary": "List eBay integrations", "description": "List all connected eBay accounts for a store", "tags": [ "eBay" ], "parameters": [], "responses": { "200": { "description": "Array of connected eBay accounts", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "integrationId": { "type": "string" }, "sellerId": { "type": "string" }, "username": { "type": "string" }, "marketplaceId": { "type": "string" } }, "required": [ "integrationId", "sellerId", "username", "marketplaceId" ] } } } } } }, "x-permission": "integration.view" } }, "/v1/integrations/ebay/{integrationId}/sync-orders": { "post": { "summary": "Sync eBay orders", "description": "Manually sync orders from eBay", "tags": [ "eBay" ], "parameters": [ { "name": "integrationId", "in": "path", "schema": { "type": "string" }, "required": true, "description": " The eBay integration ID" }, { "name": "includeShipped", "in": "query", "schema": { "type": "string" }, "description": " Include shipped orders (for testing)", "required": true }, { "name": "limit", "in": "query", "schema": { "type": "string" }, "description": " Number of orders to sync", "required": true } ], "responses": { "201": { "description": "Sync results", "content": { "application/json": { "schema": { "type": "object", "properties": { "orders": { "type": "array", "items": { "$ref": "#/components/schemas/Order" } }, "totalSynced": { "type": "number" }, "totalAvailable": { "type": "number" }, "skipped": { "type": "number" } }, "required": [ "orders", "totalSynced", "totalAvailable", "skipped" ] } } } } }, "x-permission": "integration.manage" } }, "/v1/integrations/ebay/{integrationId}/status": { "get": { "summary": "Get eBay status", "description": "Get eBay integration status", "tags": [ "eBay" ], "parameters": [ { "name": "integrationId", "in": "path", "schema": { "type": "string" }, "required": true, "description": " The eBay integration ID" } ], "responses": { "200": { "description": "Integration status", "content": { "application/json": { "schema": { "type": "object", "properties": { "connected": { "type": "boolean" }, "sellerId": { "type": "string" }, "username": { "type": "string" }, "marketplaceId": { "type": "string" }, "lastSyncedAt": { "type": "number" } }, "required": [ "connected" ] } } } } }, "x-permission": "integration.view" } }, "/v1/integrations/ebay/{integrationId}/settings": { "get": { "summary": "Get eBay settings", "description": "Get eBay integration settings", "tags": [ "eBay" ], "parameters": [ { "name": "integrationId", "in": "path", "schema": { "type": "string" }, "required": true, "description": " The eBay integration ID" } ], "responses": { "200": { "description": "Integration settings", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EbaySettings" } } } } }, "x-permission": "integration.view" }, "patch": { "summary": "Update eBay settings", "description": "Update eBay integration settings", "tags": [ "eBay" ], "parameters": [ { "name": "integrationId", "in": "path", "schema": { "type": "string" }, "required": true, "description": " The eBay integration ID" } ], "requestBody": { "description": "Settings to update", "content": { "application/json": { "schema": { "type": "object", "properties": { "autoPrint": { "type": "boolean" }, "autoCloseOrders": { "oneOf": [ { "const": "shipped" }, { "const": "delivered" }, { "const": "never" } ] } } } } }, "required": true }, "responses": { "200": { "description": "Updated settings", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EbaySettings" } } } } }, "x-permission": "integration.manage" } }, "/v1/integrations/tiktok-shop": { "get": { "summary": "List TikTok Shop integrations", "description": "List all connected TikTok Shop accounts for a store", "tags": [ "TikTok" ], "parameters": [], "responses": { "200": { "description": "Array of connected TikTok Shop accounts", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "integrationId": { "type": "string" }, "shopId": { "type": "string" }, "shopName": { "type": "string" }, "region": { "type": "string" } }, "required": [ "integrationId", "shopId", "shopName", "region" ] } } } } } }, "x-permission": "integration.view" } }, "/v1/integrations/tiktok-shop/{integrationId}/sync-orders": { "post": { "summary": "Sync TikTok Shop orders", "description": "Manually sync orders from TikTok Shop", "tags": [ "TikTok" ], "parameters": [ { "name": "integrationId", "in": "path", "schema": { "type": "string" }, "required": true, "description": " The TikTok Shop integration ID" } ], "requestBody": { "description": "Sync options — `daysBack`, `statusGroups`, and `limit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TikTokShopSyncOrdersRequest" } } }, "required": true }, "responses": { "201": { "description": "Sync results", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TikTokShopSyncOrdersResult" } } } } }, "x-permission": "integration.manage" } }, "/v1/integrations/tiktok-shop/{integrationId}/status": { "get": { "summary": "Get TikTok Shop status", "description": "Get TikTok Shop integration status", "tags": [ "TikTok" ], "parameters": [ { "name": "integrationId", "in": "path", "schema": { "type": "string" }, "required": true, "description": " The TikTok Shop integration ID" } ], "responses": { "200": { "description": "Integration status", "content": { "application/json": { "schema": { "type": "object", "properties": { "connected": { "type": "boolean" }, "shopId": { "type": "string" }, "shopName": { "type": "string" }, "region": { "type": "string" }, "lastSyncedAt": { "type": "number" }, "needsReauth": { "type": "boolean", "title": "True once the seller deauthorized the app; UI prompts a reconnect", "description": "True once the seller deauthorized the app; UI prompts a reconnect." }, "disconnectedAt": { "type": "number" } }, "required": [ "connected" ] } } } } }, "x-permission": "integration.view" } }, "/v1/integrations/tiktok-shop/{integrationId}/settings": { "get": { "summary": "Get TikTok Shop settings", "description": "Get TikTok Shop integration settings", "tags": [ "TikTok" ], "parameters": [ { "name": "integrationId", "in": "path", "schema": { "type": "string" }, "required": true, "description": " The TikTok Shop integration ID" } ], "responses": { "200": { "description": "Integration settings", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TikTokShopSettings" } } } } }, "x-permission": "integration.view" }, "patch": { "summary": "Update TikTok Shop settings", "description": "Update TikTok Shop integration settings", "tags": [ "TikTok" ], "parameters": [ { "name": "integrationId", "in": "path", "schema": { "type": "string" }, "required": true, "description": " The TikTok Shop integration ID" } ], "requestBody": { "description": "Settings to update", "content": { "application/json": { "schema": { "type": "object", "properties": { "autoPrint": { "type": "boolean" }, "autoCloseOrders": { "oneOf": [ { "const": "shipped" }, { "const": "delivered" }, { "const": "never" } ] } } } } }, "required": true }, "responses": { "200": { "description": "Updated settings", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TikTokShopSettings" } } } } }, "x-permission": "integration.manage" } }, "/v1/passkeys": { "get": { "summary": "List passkeys", "description": "List all passkeys registered by the current user", "tags": [ "Passkeys" ], "operationId": "passkeys_list", "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PasskeySummary" } } } } } } } }, "/v1/passkeys/{id}": { "patch": { "summary": "Rename a passkey", "description": "Rename a passkey", "tags": [ "Passkeys" ], "operationId": "passkeys_update", "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdatePasskeyRequest" } } }, "required": true }, "responses": { "200": { "description": "", "content": { "application/json": {} } } } }, "delete": { "summary": "Delete a passkey", "description": "Delete a passkey", "tags": [ "Passkeys" ], "operationId": "passkeys_delete", "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "", "content": { "application/json": {} } } } } }, "/v1/printers/{id}/history/last": { "get": { "summary": "Last printed history", "description": "Get the most recent print(s) on a printer, with related entities (part,\nSKU, job, order, order item) optionally inlined. \"Most recent\" means\nthe latest job that actually started printing and reached a terminal\nstate (completed, failed, or cancelled after the print began). Jobs\ncancelled while still in the queue are excluded. Each entry contains\nonly the refs you request; a requested ref with no value on the job\n(for example, a walk-in print with no order) is returned as null\nrather than being omitted. Unknown values in refs return a 400.", "tags": [ "Printers" ], "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true, "description": " The printer's unique identifier" }, { "name": "refs", "in": "query", "schema": { "type": "string", "pattern": "^(part|sku|job|order|orderItem)(?:,(part|sku|job|order|orderItem))*$" }, "required": false, "description": "Comma-separated subset of: part, sku, job, order, orderItem. Defaults\nto job when omitted." }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 25 }, "required": false, "title": "Number of recent terminal jobs to return, 1 to 25. Defaults to 1", "description": "Number of recent terminal jobs to return, 1 to 25. Defaults to 1." } ], "responses": { "200": { "description": "Printer ID and an array of last-printed entries", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrinterHistoryLastResponse" } } } } }, "x-permission": "printer.view, queue.view" } } }, "components": { "schemas": { "Part": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 1024 }, "type": { "oneOf": [ { "const": "scad" }, { "const": "cadquery" }, { "const": "build123d" }, { "const": "stl" }, { "const": "step" }, { "const": "3mf" }, { "const": "gcode3mf" }, { "const": "gcode" } ] }, "description": { "type": "string", "default": "" }, "fileUris": { "type": "array", "items": { "type": "string" }, "minItems": 1 }, "fileHashes": { "type": "array", "items": { "type": "string" }, "minItems": 1 }, "thumbnailUri": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "parameters": { "type": "array", "items": { "$ref": "#/components/schemas/PartParameter" } }, "printTags": { "$ref": "#/components/schemas/Tags" }, "overriddenProcessProfileId": { "oneOf": [ { "type": "null" }, { "type": "string", "pattern": "^[a-z0-9]{24}$" } ] }, "folderId": { "oneOf": [ { "type": "null" }, { "type": "string", "pattern": "^[a-z0-9]{24}$" } ] }, "materials": { "oneOf": [ { "type": "null" }, { "type": "array", "items": { "$ref": "#/components/schemas/PartMaterial" } } ] }, "slicerOverride": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "metadata": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/Metadata3MF" } ] }, "slicingEstimate": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/SlicingEstimate" } ] }, "use3MFProcessProfile": { "type": "boolean" }, "arrangeable": { "type": "boolean" }, "userTags": { "type": "array", "items": { "type": "string" }, "maxItems": 10 }, "gcodePlateUris": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/Recordstringstring" } ] }, "uploadedAt": { "oneOf": [ { "type": "null" }, { "type": "string", "format": "date-time" } ] }, "id": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "storeId": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "name", "type", "description", "fileUris", "fileHashes", "thumbnailUri", "parameters", "printTags", "overriddenProcessProfileId", "materials", "id", "storeId", "createdAt", "updatedAt" ] }, "PartParameter": { "type": "object", "properties": { "default": { "oneOf": [ { "type": "number" }, { "type": "string", "minLength": 0, "maxLength": 255 }, { "type": "boolean" } ] }, "options": { "type": "array", "items": { "$ref": "#/components/schemas/DropdownOption" } }, "description": { "type": "string" }, "min": { "type": "number" }, "max": { "type": "number" }, "step": { "type": "number" }, "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "type": { "oneOf": [ { "const": "number" }, { "const": "string" }, { "const": "boolean" } ] }, "value": { "oneOf": [ { "type": "number" }, { "type": "string", "minLength": 0, "maxLength": 255 }, { "type": "boolean" } ] } }, "required": [ "name", "type" ] }, "DropdownOption": { "type": "object", "properties": { "value": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "label": { "type": "string" } }, "required": [ "value" ] }, "Tags": { "type": "object", "properties": { "printer.provider": { "type": "string", "minLength": 1 }, "printer.id": { "type": "string", "minLength": 1 }, "printer.nozzleDiameter": { "type": "string", "minLength": 1 }, "printer.modelName": { "type": "string", "minLength": 1 }, "filament.type": { "type": "string", "minLength": 1 }, "user.tags": { "type": "string", "minLength": 1 } } }, "PartMaterial": { "type": "object", "properties": { "index": { "type": "number", "minimum": 0 }, "color": { "oneOf": [ { "type": "null" }, { "type": "string", "pattern": "^#{0,1}[0-9A-F]{6}|[0-9A-F]{8}$" } ] }, "type": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "skip": { "type": "boolean" }, "name": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "identifier": { "oneOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": [ "index", "color", "type" ] }, "Metadata3MF": { "type": "object", "properties": { "printerModel": { "type": "string" }, "filamentType": { "type": "array", "items": { "type": "string" } }, "filamentColors": { "type": "array", "items": { "type": "string" } }, "filamentDensities": { "type": "array", "items": { "type": "number" } }, "filamentDiameters": { "type": "array", "items": { "type": "number" } }, "nozzleDiameter": { "type": "string" }, "profileCompat": { "$ref": "#/components/schemas/ProfileCompat" }, "slicerVersion": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/SlicerVersionInfo" } ] }, "plates": { "type": "array", "items": { "$ref": "#/components/schemas/Plate3MF" } }, "filamentIds": { "type": "array", "items": { "type": "string" } } }, "required": [ "printerModel", "filamentType", "filamentColors", "nozzleDiameter", "profileCompat" ] }, "ProfileCompat": { "type": "object", "properties": { "sliced": { "type": "string" }, "compatible": { "type": "array", "items": { "type": "string" } }, "safe": { "type": "array", "items": { "type": "string" } } }, "required": [ "sliced", "compatible", "safe" ] }, "SlicerVersionInfo": { "type": "object", "properties": { "engine": { "oneOf": [ { "const": "orcaslicer" }, { "const": "bambu-studio" }, { "const": "prusaslicer" }, { "const": "superslicer" } ] }, "version": { "type": "string" } }, "required": [ "engine", "version" ] }, "Plate3MF": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "locked": { "type": "boolean" }, "filamentMapMode": { "type": "string" }, "filamentMaps": { "type": "array", "items": { "type": "number" } }, "gcodeFile": { "type": "string" }, "thumbnailFile": { "type": "string" }, "thumbnailUploadedUri": { "type": "string" }, "thumbnailNoLightFile": { "type": "string" }, "thumbnailData": { "type": "string" }, "topFile": { "type": "string" }, "pickFile": { "type": "string" }, "topData": { "type": "string", "title": "Base64 PNG data for the top/pick images, staged before upload then cleared", "description": "Base64 PNG data for the top/pick images, staged before upload then cleared." }, "pickData": { "type": "string" }, "topUploadedUri": { "type": "string", "title": "Uploaded URIs for the plate's top-down image and color-coded object pick mask", "description": "Uploaded URIs for the plate's top-down image and color-coded object pick mask.\nUsed by the visual skip-objects picker." }, "pickUploadedUri": { "type": "string" }, "patternBboxFile": { "type": "string" }, "sliced": { "$ref": "#/components/schemas/PlateSliceInfo" }, "filamentIds": { "type": "array", "items": { "type": "string" } } }, "required": [ "id" ] }, "PlateSliceInfo": { "type": "object", "properties": { "index": { "type": "number" }, "extruderType": { "type": "string" }, "nozzleVolumeType": { "type": "string" }, "printerModelId": { "type": "string" }, "nozzleDiameters": { "type": "string" }, "timelapseType": { "type": "string" }, "prediction": { "type": "number" }, "weight": { "type": "number" }, "outside": { "type": "boolean" }, "supportUsed": { "type": "boolean" }, "labelObjectEnabled": { "type": "boolean" }, "filamentMaps": { "type": "string" }, "objects": { "type": "array", "items": { "type": "object", "properties": { "identifyId": { "type": "string" }, "name": { "type": "string" }, "skipped": { "type": "boolean" } }, "required": [ "identifyId", "name", "skipped" ] } }, "filaments": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "trayInfoIdx": { "type": "string" }, "type": { "type": "string" }, "color": { "type": "string" }, "usedM": { "type": "number" }, "usedG": { "type": "number" } }, "required": [ "id", "trayInfoIdx", "type", "color", "usedM", "usedG" ] } }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "msg": { "type": "string" }, "level": { "type": "number" }, "errorCode": { "type": "string" } }, "required": [ "msg", "level", "errorCode" ] } }, "layerFilamentLists": { "type": "array", "items": { "type": "object", "properties": { "filamentList": { "type": "number" }, "layerRanges": { "type": "string" } }, "required": [ "filamentList", "layerRanges" ] } } } }, "SlicingEstimate": { "type": "object", "properties": { "estimatedPrintTimeSeconds": { "type": "number" }, "materials": { "type": "array", "items": { "$ref": "#/components/schemas/SlicingMaterialUsage" } }, "totalWeightGrams": { "type": "number" }, "profiles": { "$ref": "#/components/schemas/SlicingProfileInfo" }, "slicedAt": { "type": "string" }, "slicerVersion": { "type": "string" }, "plates": { "type": "array", "items": { "$ref": "#/components/schemas/PlateSlicingEstimate" } } }, "required": [ "estimatedPrintTimeSeconds", "materials", "totalWeightGrams", "slicedAt", "slicerVersion" ] }, "SlicingMaterialUsage": { "type": "object", "properties": { "index": { "type": "number" }, "usedGrams": { "type": "number" }, "usedMeters": { "type": "number" }, "materialType": { "type": "string" }, "color": { "type": "string" } }, "required": [ "index", "usedGrams", "usedMeters", "materialType" ] }, "SlicingProfileInfo": { "type": "object", "properties": { "machineProfileId": { "type": "string" }, "machineProfileName": { "type": "string" }, "processProfileId": { "type": "string" }, "processProfileName": { "type": "string" }, "filamentProfileIds": { "type": "array", "items": { "type": "string" } }, "filamentProfileNames": { "type": "array", "items": { "type": "string" } } }, "required": [ "machineProfileId", "machineProfileName", "processProfileId", "processProfileName", "filamentProfileIds", "filamentProfileNames" ] }, "PlateSlicingEstimate": { "type": "object", "properties": { "plateId": { "type": "number" }, "estimatedPrintTimeSeconds": { "type": "number" }, "materials": { "type": "array", "items": { "$ref": "#/components/schemas/SlicingMaterialUsage" } }, "totalWeightGrams": { "type": "number" } }, "required": [ "plateId", "estimatedPrintTimeSeconds", "materials", "totalWeightGrams" ] }, "Recordstringstring": { "type": "object", "properties": {}, "description": "Construct a type with a set of properties K of type T", "additionalProperties": { "type": "string" } }, "SearchResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Recordstringany" }, "title": "Data", "description": "Array of matching entities" }, "meta": { "type": "object", "properties": { "total": { "type": "number", "title": "Total", "description": "Total number of matching records (before pagination)" }, "count": { "type": "number", "title": "Count", "description": "Number of records returned in this response" }, "offset": { "type": "number", "title": "Offset", "description": "Number of records skipped" }, "limit": { "type": "number", "title": "Limit", "description": "Maximum number of records requested" }, "hasMore": { "type": "boolean", "title": "Has More", "description": "Whether there are more records available" }, "executionTime": { "type": "number", "title": "Execution Time", "description": "Query execution time in milliseconds" } }, "required": [ "total", "count", "offset", "limit", "hasMore", "executionTime" ], "title": "Metadata", "description": "Pagination and result metadata" } }, "required": [ "data", "meta" ], "title": "Search Response", "description": "Standardized search response with data, metadata, and query information" }, "Recordstringany": { "type": "object", "properties": {}, "description": "Construct a type with a set of properties K of type T", "additionalProperties": {} }, "namestringundefinedtypestringundefineddescriptionstringundefinedfileUrisstringundefinedfileHashesstringundefinedthumbnailUristringundefined...16more...updatedAtstringundefinedQuerySettings...": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string" }, "description": { "type": "string" }, "fileUris": { "type": "string" }, "fileHashes": { "type": "string" }, "thumbnailUri": { "type": "string" }, "parameters": { "type": "string" }, "printTags": { "type": "string" }, "overriddenProcessProfileId": { "type": "string" }, "folderId": { "type": "string" }, "materials": { "type": "string" }, "slicerOverride": { "type": "string" }, "metadata": { "type": "string" }, "slicingEstimate": { "type": "string" }, "use3MFProcessProfile": { "type": "string" }, "arrangeable": { "type": "string" }, "userTags": { "type": "string" }, "gcodePlateUris": { "type": "string" }, "uploadedAt": { "type": "string" }, "id": { "type": "string" }, "storeId": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "sort": { "type": "string", "title": "Sort", "description": "Sort specification in format \"field:asc,field2:desc\"" }, "limit": { "type": "number", "minimum": 1, "maximum": 1000, "title": "Limit", "description": "Maximum number of results to return (default: 100, max: 1000)" }, "offset": { "type": "number", "minimum": 0, "title": "Offset", "description": "Number of results to skip for pagination" }, "fields": { "type": "string", "title": "Fields", "description": "Comma-separated list of fields to return" }, "include": { "type": "string", "title": "Include", "description": "Comma-separated list of relations to include (max 4, max 2 levels deep).\nExample: \"linkedParts,linkedParts.part,folder\"" }, "meta": { "type": "boolean", "title": "Meta", "description": "If true, returns response with metadata (total, count, hasMore, etc.)" }, "hints": { "type": "boolean", "title": "Hints", "description": "If true, returns AI-friendly hints about available actions. Implies meta=true." } } }, "SearchQueryDtoPart": { "type": "object", "properties": { "filter": { "oneOf": [ { "$ref": "#/components/schemas/LogicalConditionPart" }, { "$ref": "#/components/schemas/FieldConditionPart" } ], "title": "Filter", "description": "Complex filter conditions using logical and field operators.\nAvailable field operators: eq, ne, gt, gte, lt, lte, contains, startsWith, endsWith, in, notIn, isNull, between.\nUsage example: {\"filter\": {\"and\": [{\"name\": {\"contains\": \"benchy\"}}, {\"or\": [{\"type\": {\"eq\": \"3mf\"}}, {\"type\": {\"eq\": \"gcode3mf\"}}]}}}" }, "sort": { "type": "string", "title": "Sort", "description": "Sort specification in format \"field:asc,field2:desc\"" }, "limit": { "type": "number", "minimum": 1, "maximum": 1000, "title": "Limit", "description": "Maximum number of results to return (default: 100, max: 1000)" }, "offset": { "type": "number", "minimum": 0, "title": "Offset", "description": "Number of results to skip for pagination" }, "fields": { "type": "string", "title": "Fields", "description": "Comma-separated list of fields to return" }, "include": { "type": "string", "title": "Include", "description": "Comma-separated list of relations to include (max 4, max 2 levels deep).\nExample: \"linkedParts,linkedParts.part,folder\"" }, "meta": { "type": "boolean", "title": "Meta", "description": "If true, returns response with metadata (total, count, hasMore, etc.)" }, "hints": { "type": "boolean", "title": "Hints", "description": "If true, returns AI-friendly hints about available actions. Implies meta=true." } }, "title": "Search Query", "description": "Complete search request with filter conditions and query settings" }, "LogicalConditionPart": { "type": "object", "properties": { "and": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/LogicalConditionPart" }, { "$ref": "#/components/schemas/FieldConditionPart" } ] }, "title": "AND Conditions", "description": "All conditions must be true" }, "or": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/LogicalConditionPart" }, { "$ref": "#/components/schemas/FieldConditionPart" } ] }, "title": "OR Conditions", "description": "At least one condition must be true" } }, "title": "Logical Condition", "description": "Logical operators for combining multiple filter conditions" }, "FieldConditionPart": { "type": "object", "properties": { "name": { "$ref": "#/components/schemas/FieldOperators" }, "type": { "$ref": "#/components/schemas/FieldOperators" }, "description": { "$ref": "#/components/schemas/FieldOperators" }, "fileUris": { "$ref": "#/components/schemas/FieldOperators" }, "fileHashes": { "$ref": "#/components/schemas/FieldOperators" }, "thumbnailUri": { "$ref": "#/components/schemas/FieldOperators" }, "parameters": { "$ref": "#/components/schemas/FieldOperators" }, "printTags": { "$ref": "#/components/schemas/FieldOperators" }, "overriddenProcessProfileId": { "$ref": "#/components/schemas/FieldOperators" }, "folderId": { "$ref": "#/components/schemas/FieldOperators" }, "materials": { "$ref": "#/components/schemas/FieldOperators" }, "slicerOverride": { "$ref": "#/components/schemas/FieldOperators" }, "metadata": { "$ref": "#/components/schemas/FieldOperators" }, "slicingEstimate": { "$ref": "#/components/schemas/FieldOperators" }, "use3MFProcessProfile": { "$ref": "#/components/schemas/FieldOperators" }, "arrangeable": { "$ref": "#/components/schemas/FieldOperators" }, "userTags": { "$ref": "#/components/schemas/FieldOperators" }, "gcodePlateUris": { "$ref": "#/components/schemas/FieldOperators" }, "uploadedAt": { "$ref": "#/components/schemas/FieldOperators" }, "id": { "$ref": "#/components/schemas/FieldOperators" }, "storeId": { "$ref": "#/components/schemas/FieldOperators" }, "createdAt": { "$ref": "#/components/schemas/FieldOperators" }, "updatedAt": { "$ref": "#/components/schemas/FieldOperators" } }, "title": "Field Condition", "description": "Field-based filter conditions where keys are field names and values are field operators" }, "FieldOperators": { "type": "object", "properties": { "eq": { "title": "Equals", "description": "Field value equals the specified value" }, "ne": { "title": "Not Equals", "description": "Field value does not equal the specified value" }, "gt": { "oneOf": [ { "type": "string", "format": "date-time" }, { "type": "number" } ], "title": "Greater Than", "description": "Field value is greater than the specified value" }, "gte": { "oneOf": [ { "type": "string", "format": "date-time" }, { "type": "number" } ], "title": "Greater Than or Equal", "description": "Field value is greater than or equal to the specified value" }, "lt": { "oneOf": [ { "type": "string", "format": "date-time" }, { "type": "number" } ], "title": "Less Than", "description": "Field value is less than the specified value" }, "lte": { "oneOf": [ { "type": "string", "format": "date-time" }, { "type": "number" } ], "title": "Less Than or Equal", "description": "Field value is less than or equal to the specified value" }, "contains": { "type": "string", "title": "Contains", "description": "Field value contains the specified substring (case-insensitive)" }, "startsWith": { "type": "string", "title": "Starts With", "description": "Field value starts with the specified string (case-insensitive)" }, "endsWith": { "type": "string", "title": "Ends With", "description": "Field value ends with the specified string (case-insensitive)" }, "in": { "type": "array", "items": {}, "title": "In Array", "description": "Field value is one of the specified values" }, "notIn": { "type": "array", "items": {}, "title": "Not In Array", "description": "Field value is not one of the specified values" }, "isNull": { "type": "boolean", "title": "Is Null", "description": "Field value is null or not null" }, "between": { "type": "array", "prefixItems": [ { "oneOf": [ { "type": "string", "format": "date-time" }, { "type": "number" } ] }, { "oneOf": [ { "type": "string", "format": "date-time" }, { "type": "number" } ] } ], "additionalItems": false, "title": "Between", "description": "Field value is between two values (inclusive)" } }, "title": "Field Operators", "description": "Available operators for filtering field values" }, "PartInsertWithMaterials": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 1024 }, "type": { "oneOf": [ { "const": "scad" }, { "const": "cadquery" }, { "const": "build123d" }, { "const": "stl" }, { "const": "step" }, { "const": "3mf" }, { "const": "gcode3mf" }, { "const": "gcode" } ] }, "description": { "type": "string", "default": "" }, "fileUris": { "type": "array", "items": { "type": "string" }, "minItems": 1 }, "parameters": { "type": "array", "items": { "$ref": "#/components/schemas/PartParameter" } }, "printTags": { "$ref": "#/components/schemas/Tags" }, "overriddenProcessProfileId": { "oneOf": [ { "type": "null" }, { "type": "string", "pattern": "^[a-z0-9]{24}$" } ] }, "folderId": { "oneOf": [ { "type": "null" }, { "type": "string", "pattern": "^[a-z0-9]{24}$" } ] }, "slicerOverride": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "use3MFProcessProfile": { "type": "boolean" }, "arrangeable": { "type": "boolean" }, "userTags": { "type": "array", "items": { "type": "string" }, "maxItems": 10 }, "assignedMaterials": { "$ref": "#/components/schemas/EmbeddedPartMaterialAssignments" } }, "required": [ "name", "type", "description", "fileUris", "parameters", "printTags", "overriddenProcessProfileId" ] }, "EmbeddedPartMaterialAssignments": { "type": "object", "properties": {}, "additionalProperties": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "materialId": { "type": "string" } }, "required": [ "materialId" ] }, { "type": "object", "properties": { "variantId": { "type": "string" } }, "required": [ "variantId" ] }, { "type": "object", "properties": { "materialType": { "type": "string" } }, "required": [ "materialType" ] }, { "type": "object", "properties": { "groupId": { "type": "string" } }, "required": [ "groupId" ] } ] } } }, "UpdateManyRequestPartUpdateWithMaterials": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "pattern": "^[a-z0-9]{24}$" } }, "update": { "$ref": "#/components/schemas/PartialPartUpdateWithMaterials" } }, "required": [ "ids", "update" ] }, "PartialPartUpdateWithMaterials": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 1024 }, "type": { "oneOf": [ { "const": "scad" }, { "const": "cadquery" }, { "const": "build123d" }, { "const": "stl" }, { "const": "step" }, { "const": "3mf" }, { "const": "gcode3mf" }, { "const": "gcode" } ] }, "description": { "type": "string", "default": "" }, "fileUris": { "type": "array", "items": { "type": "string" }, "minItems": 1 }, "parameters": { "type": "array", "items": { "$ref": "#/components/schemas/PartParameter" } }, "printTags": { "$ref": "#/components/schemas/Tags" }, "overriddenProcessProfileId": { "oneOf": [ { "type": "null" }, { "type": "string", "pattern": "^[a-z0-9]{24}$" } ] }, "folderId": { "oneOf": [ { "type": "null" }, { "type": "string", "pattern": "^[a-z0-9]{24}$" } ] }, "slicerOverride": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "use3MFProcessProfile": { "type": "boolean" }, "arrangeable": { "type": "boolean" }, "userTags": { "type": "array", "items": { "type": "string" }, "maxItems": 10 }, "assignedMaterials": { "$ref": "#/components/schemas/EmbeddedPartMaterialAssignments" } }, "description": "Make all properties in T optional" }, "PartUpdateWithMaterials": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 1024 }, "type": { "oneOf": [ { "const": "scad" }, { "const": "cadquery" }, { "const": "build123d" }, { "const": "stl" }, { "const": "step" }, { "const": "3mf" }, { "const": "gcode3mf" }, { "const": "gcode" } ] }, "description": { "type": "string", "default": "" }, "fileUris": { "type": "array", "items": { "type": "string" }, "minItems": 1 }, "parameters": { "type": "array", "items": { "$ref": "#/components/schemas/PartParameter" } }, "printTags": { "$ref": "#/components/schemas/Tags" }, "overriddenProcessProfileId": { "oneOf": [ { "type": "null" }, { "type": "string", "pattern": "^[a-z0-9]{24}$" } ] }, "folderId": { "oneOf": [ { "type": "null" }, { "type": "string", "pattern": "^[a-z0-9]{24}$" } ] }, "slicerOverride": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "use3MFProcessProfile": { "type": "boolean" }, "arrangeable": { "type": "boolean" }, "userTags": { "type": "array", "items": { "type": "string" }, "maxItems": 10 }, "assignedMaterials": { "$ref": "#/components/schemas/EmbeddedPartMaterialAssignments" } } }, "Sku": { "type": "object", "properties": { "sku": { "type": "string", "minLength": 1, "maxLength": 1024 }, "title": { "type": "string" }, "description": { "type": "string" }, "externalId": { "oneOf": [ { "type": "null" }, { "type": "string", "minLength": 1, "maxLength": 1024 } ] }, "externalProvider": { "oneOf": [ { "type": "null" }, { "const": "etsy" }, { "const": "shopify" } ] }, "folderId": { "oneOf": [ { "type": "null" }, { "type": "string", "pattern": "^[a-z0-9]{24}$" } ] }, "totalCogs": { "type": "number" }, "id": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "storeId": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "sku", "title", "description", "externalId", "externalProvider", "totalCogs", "id", "storeId", "createdAt", "updatedAt" ] }, "Printer": { "type": "object", "properties": { "provider": { "oneOf": [ { "const": "OctoPrint" }, { "const": "Prusa" }, { "const": "Bambu" }, { "const": "Klipper" }, { "const": "SDCP" }, { "const": "ElegooMqtt", "description": "Elegoo Centauri Carbon 2 family — uses MQTT-on-printer (embedded\nbroker on port 1883) rather than SDCP WebSocket. Distinct provider\nbecause the protocol shape, discovery (UDP 52700), and auth model\n(default `elegoo`/`123456` or access-code-derived password) all\ndiffer from `SDCP`." } ] }, "deviceId": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "providerConfig": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/BambuConfig" } ] }, "machineUserProfileId": { "oneOf": [ { "type": "null" }, { "type": "string", "pattern": "^[a-z0-9]{24}$" } ] }, "machineSystemProfileId": { "oneOf": [ { "type": "null" }, { "type": "number" } ] }, "processUserProfileId": { "oneOf": [ { "type": "null" }, { "type": "string", "pattern": "^[a-z0-9]{24}$" } ] }, "processSystemProfileId": { "oneOf": [ { "type": "null" }, { "type": "number" } ] }, "name": { "type": "string", "minLength": 1, "maxLength": 1024 }, "nozzleDiameter": { "type": "string" }, "metadata": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/BambuPrinterMetadata" }, { "$ref": "#/components/schemas/KlipperMetadata" }, { "$ref": "#/components/schemas/PrusaMetadata" }, { "$ref": "#/components/schemas/SdcpMetadata" }, { "$ref": "#/components/schemas/OctoPrintMetadata" } ] }, "proxyClientId": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "commMethod": { "oneOf": [ { "type": "null" }, { "const": "bambu-global-mqtt" }, { "const": "bambu-cloud-v2" }, { "const": "octoprint-mqtt" }, { "const": "fuse" } ] }, "enabled": { "type": "boolean" }, "tags": { "type": "array", "items": { "type": "string" } }, "confirmedReady": { "type": "boolean" }, "isAvailable": { "type": "boolean" }, "isOnline": { "type": "boolean" }, "printingJobId": { "oneOf": [ { "type": "null" }, { "type": "string", "pattern": "^[a-z0-9]{24}$" } ] }, "lastPrintedAt": { "oneOf": [ { "type": "null" }, { "type": "string", "format": "date-time" } ] }, "integrationId": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "integrationType": { "oneOf": [ { "type": "null" }, { "const": "bambulab" }, { "const": "etsy" }, { "const": "shopify" }, { "const": "ebay" }, { "const": "tiktok-shop" }, { "const": "filametrics" } ] }, "continuousPrint": { "type": "boolean" }, "fabmaticRemainingJobs": { "oneOf": [ { "type": "null" }, { "type": "number" } ] }, "modelName": { "oneOf": [ { "type": "null" }, { "type": "string" } ], "description": "Human-readable model name (e.g. \"P1S\", \"Snapmaker U1\", \"Prusa CORE One\")" }, "vendorName": { "oneOf": [ { "type": "null" }, { "type": "string" } ], "description": "Vendor/manufacturer name (e.g. \"Bambu Lab\", \"Prusa\", \"Snapmaker\")" }, "vendorModelId": { "oneOf": [ { "type": "null" }, { "type": "number" } ] }, "printerCapabilityPatch": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/JsonMergePatchPrinterCommCapabilities" } ], "title": "Per-printer capability override applied last (web Advanced Capabilities panel)", "description": "Per-printer capability override applied last (web Advanced Capabilities panel)." }, "printerAdapterBindingsPatch": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/JsonMergePatchPrinterAdapterBindings" } ], "title": "Per-printer adapter binding override applied last", "description": "Per-printer adapter binding override applied last." }, "lifetimePrintHours": { "type": "number" }, "lifetimeJobCount": { "type": "number" }, "isInMaintenance": { "type": "boolean" }, "lastMaintenanceOfflineAt": { "oneOf": [ { "type": "null" }, { "type": "string", "format": "date-time" } ] }, "lastMaintenanceOnlineAt": { "oneOf": [ { "type": "null" }, { "type": "string", "format": "date-time" } ] }, "id": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "storeId": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "provider", "deviceId", "providerConfig", "machineUserProfileId", "machineSystemProfileId", "processUserProfileId", "processSystemProfileId", "name", "nozzleDiameter", "metadata", "proxyClientId", "commMethod", "enabled", "confirmedReady", "isAvailable", "isOnline", "printingJobId", "lastPrintedAt", "integrationId", "integrationType", "continuousPrint", "fabmaticRemainingJobs", "modelName", "vendorName", "vendorModelId", "printerCapabilityPatch", "printerAdapterBindingsPatch", "lifetimePrintHours", "lifetimeJobCount", "lastMaintenanceOfflineAt", "lastMaintenanceOnlineAt", "id", "storeId", "createdAt", "updatedAt" ] }, "BambuConfig": { "type": "object", "properties": { "use_ams": { "type": "boolean" }, "do_bed_leveling": { "type": "boolean" }, "do_flow_cali": { "type": "boolean" }, "bed_type": { "oneOf": [ { "const": "Cool Plate" }, { "const": "Engineering Plate" }, { "const": "High Temp Plate" }, { "const": "Textured PEI Plate" }, { "const": "Supertack Plate" } ] }, "enable_timelapse": { "type": "boolean" }, "print_platform_type": { "type": "string" } } }, "BambuPrinterMetadata": { "type": "object", "properties": { "provider": { "const": "bambu" }, "name": { "type": "string" }, "dev_id": { "type": "string" }, "online": { "type": "boolean" }, "print_status": { "type": "string" }, "dev_model_name": { "type": "string" }, "dev_access_code": { "type": "string" }, "nozzle_diameter": { "type": "number" }, "dev_product_name": { "type": "string" } }, "required": [ "name", "dev_id", "online", "print_status", "dev_model_name", "dev_access_code", "nozzle_diameter", "dev_product_name" ] }, "KlipperMetadata": { "type": "object", "properties": { "provider": { "const": "klipper" }, "moonraker_host": { "type": "string" }, "moonraker_port": { "type": "number" }, "api_key": { "type": "string" }, "nozzle_diameter": { "type": "number" }, "extruder_count": { "type": "number" }, "kinematics": { "type": "string" }, "max_velocity": { "type": "number" }, "max_accel": { "type": "number" }, "mmu_type": { "oneOf": [ { "const": "none" }, { "const": "ercf" }, { "const": "mmu" }, { "const": "toolchanger" } ] }, "mmu_slots": { "type": "number" } }, "required": [ "provider", "moonraker_port", "nozzle_diameter", "extruder_count" ] }, "PrusaMetadata": { "type": "object", "properties": { "provider": { "const": "prusa" }, "password": { "type": "string" }, "nozzle_diameter": { "type": "number" }, "poll_interval_ms": { "type": "number" } }, "required": [ "provider", "password", "nozzle_diameter" ] }, "SdcpMetadata": { "type": "object", "properties": { "provider": { "const": "sdcp" }, "nozzle_diameter": { "type": "number" }, "mainboard_id": { "type": "string" } }, "required": [ "provider", "nozzle_diameter" ] }, "OctoPrintMetadata": { "type": "object", "properties": { "provider": { "const": "octoprint" }, "host": { "type": "string" }, "port": { "type": "number" }, "api_key": { "type": "string" }, "use_https": { "type": "boolean" }, "nozzle_diameter": { "type": "number" }, "poll_interval_ms": { "type": "number" } }, "required": [ "provider", "host", "port", "api_key" ] }, "JsonMergePatchPrinterCommCapabilities": { "type": "object", "properties": { "nozzles": { "oneOf": [ { "type": "null" }, { "type": "array", "items": { "type": "object", "properties": { "temperature": { "type": "object", "properties": { "read": { "type": "boolean" }, "set": { "type": "boolean" } } }, "extrude": { "type": "boolean" }, "toolRef": { "type": "string" }, "ref": { "type": "string", "title": "Logical reference, unique within its array. ASCII, lowercase, deterministic", "description": "Logical reference, unique within its array. ASCII, lowercase, deterministic." }, "label": { "type": "string", "description": "Human-readable display name" }, "kind": { "type": "string", "description": "Optional vendor/extensible subtype when the base role is not enough" } } } } ] }, "tools": { "oneOf": [ { "type": "null" }, { "type": "array", "items": { "type": "object", "properties": { "selectable": { "type": "boolean" }, "nozzleRefs": { "type": "array", "items": { "type": "string" } }, "fanRefs": { "type": "array", "items": { "type": "string" } }, "sensorRefs": { "type": "array", "items": { "type": "string" } }, "ref": { "type": "string", "title": "Logical reference, unique within its array. ASCII, lowercase, deterministic", "description": "Logical reference, unique within its array. ASCII, lowercase, deterministic." }, "label": { "type": "string", "description": "Human-readable display name" }, "kind": { "type": "string", "description": "Optional vendor/extensible subtype when the base role is not enough" } } } } ] }, "fans": { "oneOf": [ { "type": "null" }, { "type": "array", "items": { "type": "object", "properties": { "role": { "oneOf": [ { "const": "part" }, { "const": "aux" }, { "const": "chamber" }, { "const": "hotend" }, { "const": "exhaust" }, { "type": "object", "properties": { "length": { "type": "number", "title": "Returns the length of a String object", "description": "Returns the length of a String object." } }, "additionalProperties": { "type": "string" } } ] }, "controllable": { "type": "boolean" }, "reportsSpeed": { "type": "boolean", "description": "Whether the printer reports back a live fan speed. Defaults to true\n(omitted). Set false for write-only fans (e.g. OctoPrint, whose REST API\naccepts M106 but never surfaces a speed) so diagnostics skip the readback\nverification instead of failing a check they can't perform." }, "nozzleRef": { "type": "string" }, "toolRef": { "type": "string" }, "ref": { "type": "string", "title": "Logical reference, unique within its array. ASCII, lowercase, deterministic", "description": "Logical reference, unique within its array. ASCII, lowercase, deterministic." }, "label": { "type": "string", "description": "Human-readable display name" }, "kind": { "type": "string", "description": "Optional vendor/extensible subtype when the base role is not enough" } } } } ] }, "lights": { "oneOf": [ { "type": "null" }, { "type": "array", "items": { "type": "object", "properties": { "role": { "oneOf": [ { "const": "chamber" }, { "const": "work" }, { "const": "indicator" }, { "const": "strip" }, { "type": "object", "properties": { "length": { "type": "number", "title": "Returns the length of a String object", "description": "Returns the length of a String object." } }, "additionalProperties": { "type": "string" } } ] }, "dimmable": { "type": "boolean" }, "ref": { "type": "string", "title": "Logical reference, unique within its array. ASCII, lowercase, deterministic", "description": "Logical reference, unique within its array. ASCII, lowercase, deterministic." }, "label": { "type": "string", "description": "Human-readable display name" }, "kind": { "type": "string", "description": "Optional vendor/extensible subtype when the base role is not enough" } } } } ] }, "sensors": { "oneOf": [ { "type": "null" }, { "type": "array", "items": { "type": "object", "properties": { "role": { "oneOf": [ { "const": "lidar" }, { "const": "filament_runout" }, { "const": "door" }, { "const": "accelerometer" }, { "const": "bed_mesh" }, { "type": "object", "properties": { "length": { "type": "number", "title": "Returns the length of a String object", "description": "Returns the length of a String object." } }, "additionalProperties": { "type": "string" } } ] }, "nozzleRef": { "type": "string" }, "toolRef": { "type": "string" }, "ref": { "type": "string", "title": "Logical reference, unique within its array. ASCII, lowercase, deterministic", "description": "Logical reference, unique within its array. ASCII, lowercase, deterministic." }, "label": { "type": "string", "description": "Human-readable display name" }, "kind": { "type": "string", "description": "Optional vendor/extensible subtype when the base role is not enough" } } } } ] }, "beds": { "oneOf": [ { "type": "null" }, { "type": "array", "items": { "type": "object", "properties": { "temperature": { "type": "object", "properties": { "read": { "type": "boolean" }, "set": { "type": "boolean" } } }, "hasMesh": { "type": "boolean" }, "ref": { "type": "string", "title": "Logical reference, unique within its array. ASCII, lowercase, deterministic", "description": "Logical reference, unique within its array. ASCII, lowercase, deterministic." }, "label": { "type": "string", "description": "Human-readable display name" }, "kind": { "type": "string", "description": "Optional vendor/extensible subtype when the base role is not enough" } } } } ] }, "chambers": { "oneOf": [ { "type": "null" }, { "type": "array", "items": { "type": "object", "properties": { "temperature": { "type": "object", "properties": { "read": { "type": "boolean" }, "set": { "type": "boolean" } } }, "ref": { "type": "string", "title": "Logical reference, unique within its array. ASCII, lowercase, deterministic", "description": "Logical reference, unique within its array. ASCII, lowercase, deterministic." }, "label": { "type": "string", "description": "Human-readable display name" }, "kind": { "type": "string", "description": "Optional vendor/extensible subtype when the base role is not enough" } } } } ] }, "axes": { "oneOf": [ { "type": "null" }, { "type": "array", "items": { "type": "object", "properties": { "axis": { "oneOf": [ { "const": "x" }, { "const": "y" }, { "const": "z" } ] }, "move": { "type": "boolean" }, "home": { "type": "boolean" }, "flipped": { "type": "boolean" }, "ref": { "type": "string", "title": "Logical reference, unique within its array. ASCII, lowercase, deterministic", "description": "Logical reference, unique within its array. ASCII, lowercase, deterministic." }, "label": { "type": "string", "description": "Human-readable display name" }, "kind": { "type": "string", "description": "Optional vendor/extensible subtype when the base role is not enough" } } } } ] }, "filaments": { "oneOf": [ { "type": "null" }, { "type": "array", "items": { "type": "object", "properties": { "canReadFilament": { "type": "boolean", "title": "True if printer hardware can read filament info from this source", "description": "True if printer hardware can read filament info from this source." }, "canLoad": { "type": "boolean", "title": "True if printer can auto-load filament into this source", "description": "True if printer can auto-load filament into this source." }, "canUnload": { "type": "boolean", "title": "True if printer can auto-unload filament", "description": "True if printer can auto-unload filament." }, "ref": { "type": "string", "title": "Logical reference, unique within its array. ASCII, lowercase, deterministic", "description": "Logical reference, unique within its array. ASCII, lowercase, deterministic." }, "label": { "type": "string", "description": "Human-readable display name" }, "kind": { "type": "string", "description": "Optional vendor/extensible subtype when the base role is not enough" } } } } ], "description": "Directly-fed filament sources. An array because some printers feed\nmultiple positions simultaneously (Bambu external bay = 2, Snapmaker\nU1 = 4, Bambu H2D = 2+). Each entry is one loadable position.\nAMS / MMU / ERCF / CFS / toolchanger live separately under\n`peripherals` and are presented alongside these in the UI's\nFilaments view." }, "cameras": { "oneOf": [ { "type": "null" }, { "type": "array", "items": { "type": "object", "properties": { "protocol": { "oneOf": [ { "const": "mjpeg-bambu" }, { "const": "rtsps-bambu" }, { "const": "webrtc" }, { "const": "rtsp" }, { "const": "rtsps" }, { "const": "mjpeg-http" }, { "const": "http-snapshot" }, { "const": "http-snapshot-poll" } ] }, "mounting": { "oneOf": [ { "const": "builtin" }, { "const": "external" } ], "title": "`builtin`: seeded by the capability set, locked in the UI", "description": "`builtin`: seeded by the capability set, locked in the UI.\n`external`: user-attached; editable + removable via printer config." }, "url": { "type": "string", "description": "Literal stream URL. Required for non-Bambu protocols, EXCEPT for\n`mjpeg-http` cameras whose endpoint can be synthesized from\n`printer.ip + port` (path-agnostic MJPEG, e.g. Elegoo Centauri\nCarbon 2 on `:8080`). Set `url` when the camera is at a third-party\nabsolute address; otherwise just set `port` and let the go2rtc\ngenerator build `http://${printer.ip}:${port}/`." }, "port": { "type": "number", "title": "Override default port for the protocol", "description": "Override default port for the protocol." }, "path": { "type": "string", "description": "Override the URL path for `mjpeg-http` (default `/`). Used when the\nstream sits behind a fixed path on the printer's web server — e.g.\nMainsail/Fluidd-style `/webcam/?action=stream` for camera-streamer\nor mjpg-streamer. Combined with `printer.ip + port` to build the\nfull URL when `url` isn't set." }, "auth": { "type": "string", "description": "Auth credentials for the stream — `Bearer ...`, `user:pass`, or a\nquery-string fragment. Bambu protocols ignore this; their auth is\nderived from `printer.accessCode`." }, "role": { "oneOf": [ { "const": "overhead" }, { "const": "chamber" }, { "const": "bed" }, { "const": "toolhead" }, { "type": "object", "properties": { "length": { "type": "number", "title": "Returns the length of a String object", "description": "Returns the length of a String object." } }, "additionalProperties": { "type": "string" } } ], "title": "UX-only role for grouping/labeling", "description": "UX-only role for grouping/labeling." }, "snapshots": { "type": "boolean", "title": "Whether to capture periodic snapshots. Defaults true if unset", "description": "Whether to capture periodic snapshots. Defaults true if unset." }, "timelapse": { "type": "boolean", "title": "Whether to record timelapses. Defaults true if unset", "description": "Whether to record timelapses. Defaults true if unset." }, "primary": { "type": "boolean", "description": "When true, this is the printer's primary camera: it owns the bare\n`printer.id` go2rtc stream key, so the live dashboard/printer tile,\nperiodic snapshots, the print-completion thumbnail, and timelapses\nall read from it instead of the built-in camera. At most one camera\nper printer should set this; when none do, the first camera\n(index 0, normally the built-in) is the implicit primary." }, "webrtcSignaling": { "type": "object", "properties": { "flavor": { "oneOf": [ { "const": "whep" }, { "const": "creality-base64-json" }, { "const": "go2rtc-ws" } ] }, "path": { "type": "string", "title": "Endpoint path or full URL for the signaling request", "description": "Endpoint path or full URL for the signaling request." } }, "description": "SDP-exchange config for `protocol: 'webrtc'`. Required when protocol\nis `'webrtc'`; ignored otherwise. The transport itself is always\nstandard WebRTC; this only describes how the offer/answer get traded.\n\nFor `creality-base64-json`, the signaling URL is built from\n`printer.ip:port` + `path` (e.g. http://192.168.1.26:8000/call/webrtc_local).\nFor `whep`, `path` may be a full URL or a path appended to the camera's\nbase URL." }, "ref": { "type": "string", "title": "Logical reference, unique within its array. ASCII, lowercase, deterministic", "description": "Logical reference, unique within its array. ASCII, lowercase, deterministic." }, "label": { "type": "string", "description": "Human-readable display name" }, "kind": { "type": "string", "description": "Optional vendor/extensible subtype when the base role is not enough" } } } } ], "description": "Cameras attached to the printer. Built-in (`mounting:'builtin'`)\ncameras come from the printer's capability set; external IP/RTSP\ncameras (`mounting:'external'`) are added via printer config.\n\nReplaces the legacy `getCameraProtocol(modelCode)` lookup — all\ncamera config flows through this array." }, "peripherals": { "oneOf": [ { "type": "null" }, { "type": "array", "items": { "type": "object", "properties": { "type": { "oneOf": [ { "const": "ercf" }, { "const": "mmu" }, { "const": "toolchanger" }, { "const": "ams" }, { "type": "object", "properties": { "length": { "type": "number", "title": "Returns the length of a String object", "description": "Returns the length of a String object." } }, "additionalProperties": { "type": "string" } } ] }, "maxUnits": { "type": "number" }, "slotsPerUnit": { "type": "number" }, "minSlotsPerUnit": { "type": "number" }, "maxSlotsPerUnit": { "type": "number" }, "canReadFilament": { "type": "boolean" }, "canLoad": { "type": "boolean" }, "canUnload": { "type": "boolean" }, "ref": { "type": "string", "title": "Logical reference, unique within its array. ASCII, lowercase, deterministic", "description": "Logical reference, unique within its array. ASCII, lowercase, deterministic." }, "label": { "type": "string", "description": "Human-readable display name" }, "kind": { "type": "string", "description": "Optional vendor/extensible subtype when the base role is not enough" } } } } ] }, "printing": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/JsonMergePatch__type" } ] }, "filament": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/JsonMergePatch__type.o1" } ] }, "files": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/JsonMergePatch__type.o2" } ] }, "gcode": { "oneOf": [ { "type": "null" }, { "type": "boolean" } ] }, "printOptions": { "oneOf": [ { "type": "null" }, { "type": "array", "items": { "type": "object", "properties": { "kind": { "oneOf": [ { "const": "boolean" }, { "const": "enum" } ] }, "default": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ], "title": "UI default when the stored providerConfig is null / missing the key", "description": "UI default when the stored providerConfig is null / missing the key." }, "choices": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "label": { "type": "string" } } }, "title": "For `kind: \"enum\"`: allowed values with display labels", "description": "For `kind: \"enum\"`: allowed values with display labels." }, "description": { "type": "string", "title": "Tooltip help text rendered next to the label", "description": "Tooltip help text rendered next to the label." }, "ref": { "type": "string", "title": "Logical reference, unique within its array. ASCII, lowercase, deterministic", "description": "Logical reference, unique within its array. ASCII, lowercase, deterministic." }, "label": { "type": "string", "description": "Human-readable display name" } } } } ] } }, "description": "JSON Merge Patch style type:\n- `null` removes a key\n- arrays replace the target value (or merge-by-ref for component arrays,\n handled at runtime in `applyCapabilitiesPatch`)\n\nArray elements use `DeepPartial` so callers can supply just the\nfields they're changing (e.g. `{ ref: 'fan_part', controllable: false }`\nwithout restating `role` / `label`). `applyCapabilitiesPatch` merges\ncomponent arrays by `ref` at runtime, so partial elements compose with\nthe base shape correctly. Non-component arrays follow standard\nreplace-the-whole-thing semantics — supply full elements for those.\n\nTests `NonNullable` first so optional fields recurse correctly:\nthe previous `T[P] extends Array` check failed for optional\narrays (the `undefined` union member kept the array branch from\nmatching) and fell through to the object branch, producing\n`Array` shapes that nestia rejects." }, "JsonMergePatch__type": { "type": "object", "properties": { "start": { "oneOf": [ { "type": "null" }, { "type": "boolean" } ] }, "pause": { "oneOf": [ { "type": "null" }, { "type": "boolean" } ] }, "resume": { "oneOf": [ { "type": "null" }, { "type": "boolean" } ] }, "stop": { "oneOf": [ { "type": "null" }, { "type": "boolean" } ] }, "skipObjects": { "oneOf": [ { "type": "null" }, { "type": "boolean" } ] } }, "description": "JSON Merge Patch style type:\n- `null` removes a key\n- arrays replace the target value (or merge-by-ref for component arrays,\n handled at runtime in `applyCapabilitiesPatch`)\n\nArray elements use `DeepPartial` so callers can supply just the\nfields they're changing (e.g. `{ ref: 'fan_part', controllable: false }`\nwithout restating `role` / `label`). `applyCapabilitiesPatch` merges\ncomponent arrays by `ref` at runtime, so partial elements compose with\nthe base shape correctly. Non-component arrays follow standard\nreplace-the-whole-thing semantics — supply full elements for those.\n\nTests `NonNullable` first so optional fields recurse correctly:\nthe previous `T[P] extends Array` check failed for optional\narrays (the `undefined` union member kept the array branch from\nmatching) and fell through to the object branch, producing\n`Array` shapes that nestia rejects." }, "JsonMergePatch__type.o1": { "type": "object", "properties": { "setInfo": { "oneOf": [ { "type": "null" }, { "type": "boolean" } ] }, "read": { "oneOf": [ { "type": "null" }, { "type": "boolean" } ] }, "dynamicSlots": { "oneOf": [ { "type": "null" }, { "type": "boolean" } ] } }, "description": "JSON Merge Patch style type:\n- `null` removes a key\n- arrays replace the target value (or merge-by-ref for component arrays,\n handled at runtime in `applyCapabilitiesPatch`)\n\nArray elements use `DeepPartial` so callers can supply just the\nfields they're changing (e.g. `{ ref: 'fan_part', controllable: false }`\nwithout restating `role` / `label`). `applyCapabilitiesPatch` merges\ncomponent arrays by `ref` at runtime, so partial elements compose with\nthe base shape correctly. Non-component arrays follow standard\nreplace-the-whole-thing semantics — supply full elements for those.\n\nTests `NonNullable` first so optional fields recurse correctly:\nthe previous `T[P] extends Array` check failed for optional\narrays (the `undefined` union member kept the array branch from\nmatching) and fell through to the object branch, producing\n`Array` shapes that nestia rejects." }, "JsonMergePatch__type.o2": { "type": "object", "properties": { "upload": { "oneOf": [ { "type": "null" }, { "type": "boolean" } ] }, "list": { "oneOf": [ { "type": "null" }, { "type": "boolean" } ] } }, "description": "JSON Merge Patch style type:\n- `null` removes a key\n- arrays replace the target value (or merge-by-ref for component arrays,\n handled at runtime in `applyCapabilitiesPatch`)\n\nArray elements use `DeepPartial` so callers can supply just the\nfields they're changing (e.g. `{ ref: 'fan_part', controllable: false }`\nwithout restating `role` / `label`). `applyCapabilitiesPatch` merges\ncomponent arrays by `ref` at runtime, so partial elements compose with\nthe base shape correctly. Non-component arrays follow standard\nreplace-the-whole-thing semantics — supply full elements for those.\n\nTests `NonNullable` first so optional fields recurse correctly:\nthe previous `T[P] extends Array` check failed for optional\narrays (the `undefined` union member kept the array branch from\nmatching) and fell through to the object branch, producing\n`Array` shapes that nestia rejects." }, "JsonMergePatchPrinterAdapterBindings": { "type": "object", "properties": { "bambu": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/JsonMergePatchBambuAdapterBindings" } ] }, "klipper": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/JsonMergePatchKlipperAdapterBindings" } ] }, "prusa": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/JsonMergePatchPrusaAdapterBindings" } ] }, "sdcp": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/JsonMergePatchSdcpAdapterBindings" } ] }, "elegoo-mqtt": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/JsonMergePatchElegooMqttAdapterBindings" } ] }, "octoprint": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/JsonMergePatchOctoprintAdapterBindings" } ] } }, "description": "JSON Merge Patch style type:\n- `null` removes a key\n- arrays replace the target value (or merge-by-ref for component arrays,\n handled at runtime in `applyCapabilitiesPatch`)\n\nArray elements use `DeepPartial` so callers can supply just the\nfields they're changing (e.g. `{ ref: 'fan_part', controllable: false }`\nwithout restating `role` / `label`). `applyCapabilitiesPatch` merges\ncomponent arrays by `ref` at runtime, so partial elements compose with\nthe base shape correctly. Non-component arrays follow standard\nreplace-the-whole-thing semantics — supply full elements for those.\n\nTests `NonNullable` first so optional fields recurse correctly:\nthe previous `T[P] extends Array` check failed for optional\narrays (the `undefined` union member kept the array branch from\nmatching) and fell through to the object branch, producing\n`Array` shapes that nestia rejects." }, "JsonMergePatchBambuAdapterBindings": { "type": "object", "properties": { "schemaVersion": { "oneOf": [ { "type": "null" }, { "const": 1 } ], "description": "Shape version. Present on v1 payloads; absent on legacy payloads that\npre-date the refactor. Resolvers branch on this: v1 uses the adapter-\nlevel `commands` map + component kinds; legacy falls back to per-ref\nprefix conventions so old data keeps rendering." }, "commands": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/JsonMergePatchPartialRecordBambuCommandNameTemplateBinding" } ], "title": "Adapter-level command templates. Populated on v1 bindings", "description": "Adapter-level command templates. Populated on v1 bindings." }, "components": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/JsonMergePatchRecordstringBambuComponentBinding" } ], "title": "Component bindings keyed by Printago ref", "description": "Component bindings keyed by Printago ref." }, "printOptions": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/JsonMergePatchRecordstringBambuPrintOptionBinding" } ], "description": "Print-option bindings keyed by capability ref. Used by the Bambu\ncommand generator to build the `print.project_file` payload from the\nstored `providerConfig`. Also consumed by the web form to bind each\nUI widget to the right storage key." } }, "description": "JSON Merge Patch style type:\n- `null` removes a key\n- arrays replace the target value (or merge-by-ref for component arrays,\n handled at runtime in `applyCapabilitiesPatch`)\n\nArray elements use `DeepPartial` so callers can supply just the\nfields they're changing (e.g. `{ ref: 'fan_part', controllable: false }`\nwithout restating `role` / `label`). `applyCapabilitiesPatch` merges\ncomponent arrays by `ref` at runtime, so partial elements compose with\nthe base shape correctly. Non-component arrays follow standard\nreplace-the-whole-thing semantics — supply full elements for those.\n\nTests `NonNullable` first so optional fields recurse correctly:\nthe previous `T[P] extends Array` check failed for optional\narrays (the `undefined` union member kept the array branch from\nmatching) and fell through to the object branch, producing\n`Array` shapes that nestia rejects." }, "JsonMergePatchPartialRecordBambuCommandNameTemplateBinding": { "type": "object", "properties": { "setNozzleTemperature": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/JsonMergePatchTemplateBinding" } ] }, "setBedTemperature": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/JsonMergePatchTemplateBinding" } ] }, "setFan": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/JsonMergePatchTemplateBinding" } ] }, "setLight": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/JsonMergePatchTemplateBinding" } ] }, "selectTool": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/JsonMergePatchTemplateBinding" } ] } }, "description": "JSON Merge Patch style type:\n- `null` removes a key\n- arrays replace the target value (or merge-by-ref for component arrays,\n handled at runtime in `applyCapabilitiesPatch`)\n\nArray elements use `DeepPartial` so callers can supply just the\nfields they're changing (e.g. `{ ref: 'fan_part', controllable: false }`\nwithout restating `role` / `label`). `applyCapabilitiesPatch` merges\ncomponent arrays by `ref` at runtime, so partial elements compose with\nthe base shape correctly. Non-component arrays follow standard\nreplace-the-whole-thing semantics — supply full elements for those.\n\nTests `NonNullable` first so optional fields recurse correctly:\nthe previous `T[P] extends Array` check failed for optional\narrays (the `undefined` union member kept the array branch from\nmatching) and fell through to the object branch, producing\n`Array` shapes that nestia rejects." }, "JsonMergePatchTemplateBinding": { "type": "object", "properties": { "template": { "oneOf": [ { "type": "null" }, { "type": "string" } ], "description": "Protocol-specific command template. Supports flat and dotted-path\nplaceholders resolved by renderBindingTemplate. Common placeholders:\n- {temperature}, {speed}, {fraction}, {pwm}, {value} — scalar arguments\n- {component.heater}, {component.fan}, {component.selectCommand} — fields\n from the resolved component binding\n- {klipper.} — adapter-level fields (reserved; currently unused)\nMissing placeholders cause the template to fail rendering with the\nstructured { ok: false, missing: string[] } result." } }, "description": "JSON Merge Patch style type:\n- `null` removes a key\n- arrays replace the target value (or merge-by-ref for component arrays,\n handled at runtime in `applyCapabilitiesPatch`)\n\nArray elements use `DeepPartial` so callers can supply just the\nfields they're changing (e.g. `{ ref: 'fan_part', controllable: false }`\nwithout restating `role` / `label`). `applyCapabilitiesPatch` merges\ncomponent arrays by `ref` at runtime, so partial elements compose with\nthe base shape correctly. Non-component arrays follow standard\nreplace-the-whole-thing semantics — supply full elements for those.\n\nTests `NonNullable` first so optional fields recurse correctly:\nthe previous `T[P] extends Array` check failed for optional\narrays (the `undefined` union member kept the array branch from\nmatching) and fell through to the object branch, producing\n`Array` shapes that nestia rejects." }, "JsonMergePatchRecordstringBambuComponentBinding": { "type": "object", "properties": {}, "description": "JSON Merge Patch style type:\n- `null` removes a key\n- arrays replace the target value (or merge-by-ref for component arrays,\n handled at runtime in `applyCapabilitiesPatch`)\n\nArray elements use `DeepPartial` so callers can supply just the\nfields they're changing (e.g. `{ ref: 'fan_part', controllable: false }`\nwithout restating `role` / `label`). `applyCapabilitiesPatch` merges\ncomponent arrays by `ref` at runtime, so partial elements compose with\nthe base shape correctly. Non-component arrays follow standard\nreplace-the-whole-thing semantics — supply full elements for those.\n\nTests `NonNullable` first so optional fields recurse correctly:\nthe previous `T[P] extends Array` check failed for optional\narrays (the `undefined` union member kept the array branch from\nmatching) and fell through to the object branch, producing\n`Array` shapes that nestia rejects.", "additionalProperties": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/JsonMergePatchBambuComponentBinding" } ] } }, "JsonMergePatchBambuComponentBinding": { "type": "object", "properties": { "kind": { "oneOf": [ { "type": "null" }, { "const": "nozzle" }, { "const": "bed" }, { "const": "fan" }, { "const": "light" }, { "const": "tool" } ], "description": "Kind discriminator. Present on every v1 component. Legacy Bambu\nbindings (pre-v1) may omit this; the resolver falls back to the\nref-prefix convention (`nozzle_` → nozzle, `fan_` → fan, etc.) so\nolder data keeps working through the deprecation window." }, "fanChannel": { "oneOf": [ { "type": "null" }, { "type": "string" } ], "description": "For `fan` components: Bambu's channel label used by the adapter-level\n`setFan` template (`M106 {component.fanChannel} S{pwm}`). Examples:\n`P1`, `P2`, `P3`." }, "ledNode": { "oneOf": [ { "type": "null" }, { "type": "string" } ], "title": "For `light` components: the printer-side LED node name (e.g", "description": "For `light` components: the printer-side LED node name (e.g.\n`chamber_light`, `work_light`) used by the adapter-level `setLight`\ntemplate. Bambu light commands are MQTT JSON, not gcode — callers\nread this value directly via `resolveBambuLedNode`." }, "selectCommand": { "oneOf": [ { "type": "null" }, { "type": "string" } ], "description": "For `tool` components: the gcode fragment the `selectTool` template\nuses to switch to this tool. IDEX printers (H2D/H2C) expose this." }, "temperatureCommand": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/JsonMergePatchTemplateBinding" } ], "title": "Optional per-component override for the temperature command template", "description": "Optional per-component override for the temperature command template.\nTakes precedence over the adapter-level `commands.setNozzleTemperature`\n/ `setBedTemperature`. Use only when a specific ref needs non-standard\ngcode (very rare on Bambu, which uses Marlin-style M104/M140 for every\nnozzle + bed)." }, "fanCommand": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/JsonMergePatchTemplateBinding" } ], "title": "Per-component override for the fan command template. Rare", "description": "Per-component override for the fan command template. Rare." }, "toolSelectCommand": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/JsonMergePatchTemplateBinding" } ], "title": "Per-component override for the tool-select template. Rare", "description": "Per-component override for the tool-select template. Rare." } }, "description": "JSON Merge Patch style type:\n- `null` removes a key\n- arrays replace the target value (or merge-by-ref for component arrays,\n handled at runtime in `applyCapabilitiesPatch`)\n\nArray elements use `DeepPartial` so callers can supply just the\nfields they're changing (e.g. `{ ref: 'fan_part', controllable: false }`\nwithout restating `role` / `label`). `applyCapabilitiesPatch` merges\ncomponent arrays by `ref` at runtime, so partial elements compose with\nthe base shape correctly. Non-component arrays follow standard\nreplace-the-whole-thing semantics — supply full elements for those.\n\nTests `NonNullable` first so optional fields recurse correctly:\nthe previous `T[P] extends Array` check failed for optional\narrays (the `undefined` union member kept the array branch from\nmatching) and fell through to the object branch, producing\n`Array` shapes that nestia rejects." }, "JsonMergePatchRecordstringBambuPrintOptionBinding": { "type": "object", "properties": {}, "description": "JSON Merge Patch style type:\n- `null` removes a key\n- arrays replace the target value (or merge-by-ref for component arrays,\n handled at runtime in `applyCapabilitiesPatch`)\n\nArray elements use `DeepPartial` so callers can supply just the\nfields they're changing (e.g. `{ ref: 'fan_part', controllable: false }`\nwithout restating `role` / `label`). `applyCapabilitiesPatch` merges\ncomponent arrays by `ref` at runtime, so partial elements compose with\nthe base shape correctly. Non-component arrays follow standard\nreplace-the-whole-thing semantics — supply full elements for those.\n\nTests `NonNullable` first so optional fields recurse correctly:\nthe previous `T[P] extends Array` check failed for optional\narrays (the `undefined` union member kept the array branch from\nmatching) and fell through to the object branch, producing\n`Array` shapes that nestia rejects.", "additionalProperties": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/JsonMergePatchBambuPrintOptionBinding" } ] } }, "JsonMergePatchBambuPrintOptionBinding": { "type": "object", "properties": { "storageKey": { "oneOf": [ { "type": "null" }, { "type": "string" } ], "description": "Key inside `printer.providerConfig` (a `BambuConfig` today) that\nholds this option's stored value. Lets the capability-schema ref\nstay clean (`bed_leveling`) while the stored field keeps its\nhistorical name (`do_bed_leveling`). No DB migration on stored rows." }, "payloadField": { "oneOf": [ { "type": "null" }, { "type": "string" } ], "title": "Field name inside the MQTT `print.project_file` payload", "description": "Field name inside the MQTT `print.project_file` payload." }, "defaultValue": { "oneOf": [ { "type": "null" }, { "type": "string" }, { "type": "boolean" } ], "description": "Value written into the payload when `providerConfig` omits the\noption entirely. Matches the current hardcoded `?? false` / `?? \"auto\"`\ndefaults so behaviour doesn't change when this field is absent." } }, "description": "JSON Merge Patch style type:\n- `null` removes a key\n- arrays replace the target value (or merge-by-ref for component arrays,\n handled at runtime in `applyCapabilitiesPatch`)\n\nArray elements use `DeepPartial` so callers can supply just the\nfields they're changing (e.g. `{ ref: 'fan_part', controllable: false }`\nwithout restating `role` / `label`). `applyCapabilitiesPatch` merges\ncomponent arrays by `ref` at runtime, so partial elements compose with\nthe base shape correctly. Non-component arrays follow standard\nreplace-the-whole-thing semantics — supply full elements for those.\n\nTests `NonNullable` first so optional fields recurse correctly:\nthe previous `T[P] extends Array` check failed for optional\narrays (the `undefined` union member kept the array branch from\nmatching) and fell through to the object branch, producing\n`Array` shapes that nestia rejects." }, "JsonMergePatchKlipperAdapterBindings": { "type": "object", "properties": { "schemaVersion": { "oneOf": [ { "type": "null" }, { "const": 1 } ] }, "modules": { "oneOf": [ { "type": "null" }, { "type": "array", "items": { "type": "string" } } ], "description": "Stable identifiers of fuse-lib Klipper modules that own vendor-specific\nparsing, subscriptions, side-channel pollers, and commands for this\nprinter. Mixins declare their required modules here; the resolver\nunions across mixins (see `resolveAdapterBindings`). Names that the\nrunning fuse build doesn't recognize are non-fatal — fuse logs a\nwarning and ignores them, matching the same drift-tolerance pattern\nas `getMixinsForVendorModel`'s `matchType`.\n\nExamples: `snapmaker_u1`, `creality_cfs`, `creality_filament_rack`,\n`creality_k2_commands`." }, "commands": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/JsonMergePatchPartialRecordKlipperCommandNameTemplateBinding" } ], "title": "Adapter-level default command templates, keyed by canonical name", "description": "Adapter-level default command templates, keyed by canonical name.\nTemplates pull per-ref fields via placeholders such as\n`{component.heater}` so one template covers every nozzle or bed." }, "components": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/JsonMergePatchRecordstringKlipperComponentBinding" } ], "description": "Component bindings keyed by Printago ref. The same ref map is both\nthe stats-lookup source and the command-resolution source." }, "printOptions": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/JsonMergePatchRecordstringAdapterPrintOptionBinding" } ], "title": "Per-print-job option bindings — empty today; reserved for future use", "description": "Per-print-job option bindings — empty today; reserved for future use." } }, "description": "JSON Merge Patch style type:\n- `null` removes a key\n- arrays replace the target value (or merge-by-ref for component arrays,\n handled at runtime in `applyCapabilitiesPatch`)\n\nArray elements use `DeepPartial` so callers can supply just the\nfields they're changing (e.g. `{ ref: 'fan_part', controllable: false }`\nwithout restating `role` / `label`). `applyCapabilitiesPatch` merges\ncomponent arrays by `ref` at runtime, so partial elements compose with\nthe base shape correctly. Non-component arrays follow standard\nreplace-the-whole-thing semantics — supply full elements for those.\n\nTests `NonNullable` first so optional fields recurse correctly:\nthe previous `T[P] extends Array` check failed for optional\narrays (the `undefined` union member kept the array branch from\nmatching) and fell through to the object branch, producing\n`Array` shapes that nestia rejects." }, "JsonMergePatchPartialRecordKlipperCommandNameTemplateBinding": { "type": "object", "properties": { "setNozzleTemperature": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/JsonMergePatchTemplateBinding" } ] }, "setBedTemperature": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/JsonMergePatchTemplateBinding" } ] }, "setFan": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/JsonMergePatchTemplateBinding" } ] }, "setLight": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/JsonMergePatchTemplateBinding" } ] }, "selectTool": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/JsonMergePatchTemplateBinding" } ] }, "setChamberTemperature": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/JsonMergePatchTemplateBinding" } ] } }, "description": "JSON Merge Patch style type:\n- `null` removes a key\n- arrays replace the target value (or merge-by-ref for component arrays,\n handled at runtime in `applyCapabilitiesPatch`)\n\nArray elements use `DeepPartial` so callers can supply just the\nfields they're changing (e.g. `{ ref: 'fan_part', controllable: false }`\nwithout restating `role` / `label`). `applyCapabilitiesPatch` merges\ncomponent arrays by `ref` at runtime, so partial elements compose with\nthe base shape correctly. Non-component arrays follow standard\nreplace-the-whole-thing semantics — supply full elements for those.\n\nTests `NonNullable` first so optional fields recurse correctly:\nthe previous `T[P] extends Array` check failed for optional\narrays (the `undefined` union member kept the array branch from\nmatching) and fell through to the object branch, producing\n`Array` shapes that nestia rejects." }, "JsonMergePatchRecordstringKlipperComponentBinding": { "type": "object", "properties": {}, "description": "JSON Merge Patch style type:\n- `null` removes a key\n- arrays replace the target value (or merge-by-ref for component arrays,\n handled at runtime in `applyCapabilitiesPatch`)\n\nArray elements use `DeepPartial` so callers can supply just the\nfields they're changing (e.g. `{ ref: 'fan_part', controllable: false }`\nwithout restating `role` / `label`). `applyCapabilitiesPatch` merges\ncomponent arrays by `ref` at runtime, so partial elements compose with\nthe base shape correctly. Non-component arrays follow standard\nreplace-the-whole-thing semantics — supply full elements for those.\n\nTests `NonNullable` first so optional fields recurse correctly:\nthe previous `T[P] extends Array` check failed for optional\narrays (the `undefined` union member kept the array branch from\nmatching) and fell through to the object branch, producing\n`Array` shapes that nestia rejects.", "additionalProperties": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/JsonMergePatchKlipperComponentBinding" } ] } }, "JsonMergePatchKlipperComponentBinding": { "type": "object", "properties": { "kind": { "oneOf": [ { "type": "null" }, { "const": "chamber" }, { "const": "nozzle" }, { "const": "bed" }, { "const": "fan" }, { "const": "light" }, { "const": "tool" } ], "title": "Required for every binding — drives parser/UI dispatch", "description": "Required for every binding — drives parser/UI dispatch." }, "statusObject": { "oneOf": [ { "type": "null" }, { "type": "string" } ], "description": "Moonraker object name that the Klipper state parser reads (and that\nthe Moonraker subscription builder derives its object list from).\nExamples: `extruder`, `extruder1`, `heater_bed`,\n`temperature_sensor chamber`, `fan`, `fan_generic aux`.\nOmit on abstract/virtual components (e.g. a `tool` that only\ngenerates a gcode select command and has no readable status)." }, "heater": { "oneOf": [ { "type": "null" }, { "type": "string" } ], "description": "Klipper heater command target used by the adapter-level\n`setNozzleTemperature` / `setBedTemperature` / `setChamberTemperature`\ntemplates (e.g. `SET_HEATER_TEMPERATURE HEATER={component.heater}`).\nNot every component that has `statusObject` has a heater — a read-only\n`temperature_sensor` chamber is the canonical example." }, "activeExtruderObject": { "oneOf": [ { "type": "null" }, { "type": "string" } ], "title": "Klipper extruder object name as it appears in `toolhead.extruder`", "description": "Klipper extruder object name as it appears in `toolhead.extruder`.\nUsed to invert the active-tool status back into a ref. Usually\nidentical to `statusObject` for nozzles; kept separate so exotic\nconfigurations can diverge." }, "toolRef": { "oneOf": [ { "type": "null" }, { "type": "string" } ], "description": "For heater-bearing components (nozzles) that have a selectable tool\ncounterpart: the ref of the matching `tool_N` component. Single-extruder\nprinters with no selectable-tool concept leave this undefined." }, "selectCommand": { "oneOf": [ { "type": "null" }, { "type": "string" } ], "description": "For `tool` components: the gcode fragment the `selectTool` template\nuses to switch to this tool (e.g. `T0`, `ACTIVATE_EXTRUDER EXTRUDER=extruder1`,\nor a vendor-specific macro call)." }, "nozzleRefs": { "oneOf": [ { "type": "null" }, { "type": "array", "items": { "type": "string" } } ], "description": "For `tool` components: the nozzle refs this tool activates. For most\nmachines a tool drives exactly one nozzle, but toolchangers can\ntheoretically share heaters." }, "fan": { "oneOf": [ { "type": "null" }, { "type": "string" } ], "description": "For `fan` components: the Klipper fan name used by\n`SET_FAN_SPEED FAN={component.fan}` (no value for the primary `[fan]`\nsection, which uses M106 and gets a per-component override template\ninstead)." }, "led": { "oneOf": [ { "type": "null" }, { "type": "string" } ], "description": "For `light` components: the Klipper-side pin or LED node identifier\nreferenced from the `setLight` template (e.g. `{component.led}` in\n`SET_PIN PIN={component.led} VALUE={value}` or\n`SET_LED LED={component.led} ...`). The exact gcode/macro shape lives\nin the adapter's command template; this field just carries the name." }, "commandTemplate": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/JsonMergePatchTemplateBinding" } ], "description": "Optional per-component command-template override. Takes precedence\nover the adapter-level `commands` template when resolving. Use only\nwhen a specific printer needs non-standard gcode for this ref\n(e.g. `M106 S{pwm}` for the primary part fan, or a vendor macro)." } }, "description": "JSON Merge Patch style type:\n- `null` removes a key\n- arrays replace the target value (or merge-by-ref for component arrays,\n handled at runtime in `applyCapabilitiesPatch`)\n\nArray elements use `DeepPartial` so callers can supply just the\nfields they're changing (e.g. `{ ref: 'fan_part', controllable: false }`\nwithout restating `role` / `label`). `applyCapabilitiesPatch` merges\ncomponent arrays by `ref` at runtime, so partial elements compose with\nthe base shape correctly. Non-component arrays follow standard\nreplace-the-whole-thing semantics — supply full elements for those.\n\nTests `NonNullable` first so optional fields recurse correctly:\nthe previous `T[P] extends Array` check failed for optional\narrays (the `undefined` union member kept the array branch from\nmatching) and fell through to the object branch, producing\n`Array` shapes that nestia rejects." }, "JsonMergePatchRecordstringAdapterPrintOptionBinding": { "type": "object", "properties": {}, "description": "JSON Merge Patch style type:\n- `null` removes a key\n- arrays replace the target value (or merge-by-ref for component arrays,\n handled at runtime in `applyCapabilitiesPatch`)\n\nArray elements use `DeepPartial` so callers can supply just the\nfields they're changing (e.g. `{ ref: 'fan_part', controllable: false }`\nwithout restating `role` / `label`). `applyCapabilitiesPatch` merges\ncomponent arrays by `ref` at runtime, so partial elements compose with\nthe base shape correctly. Non-component arrays follow standard\nreplace-the-whole-thing semantics — supply full elements for those.\n\nTests `NonNullable` first so optional fields recurse correctly:\nthe previous `T[P] extends Array` check failed for optional\narrays (the `undefined` union member kept the array branch from\nmatching) and fell through to the object branch, producing\n`Array` shapes that nestia rejects.", "additionalProperties": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/JsonMergePatchAdapterPrintOptionBinding" } ] } }, "JsonMergePatchAdapterPrintOptionBinding": { "type": "object", "properties": { "storageKey": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "payloadField": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "defaultValue": { "oneOf": [ { "type": "null" }, { "type": "string" }, { "type": "boolean" } ] } }, "description": "JSON Merge Patch style type:\n- `null` removes a key\n- arrays replace the target value (or merge-by-ref for component arrays,\n handled at runtime in `applyCapabilitiesPatch`)\n\nArray elements use `DeepPartial` so callers can supply just the\nfields they're changing (e.g. `{ ref: 'fan_part', controllable: false }`\nwithout restating `role` / `label`). `applyCapabilitiesPatch` merges\ncomponent arrays by `ref` at runtime, so partial elements compose with\nthe base shape correctly. Non-component arrays follow standard\nreplace-the-whole-thing semantics — supply full elements for those.\n\nTests `NonNullable` first so optional fields recurse correctly:\nthe previous `T[P] extends Array` check failed for optional\narrays (the `undefined` union member kept the array branch from\nmatching) and fell through to the object branch, producing\n`Array` shapes that nestia rejects." }, "JsonMergePatchPrusaAdapterBindings": { "type": "object", "properties": { "schemaVersion": { "oneOf": [ { "type": "null" }, { "const": 1 } ] }, "components": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/JsonMergePatchRecordstringPrusaComponentBinding" } ], "description": "Component bindings keyed by Printago ref. Used by\n`PrusaStateParser` to turn PrusaLink status fields into ref-indexed\nPrinterStatData entries. PrusaLink's command surface is API-level\n(start/pause/resume/stop), so this adapter has no `commands` map —\nthat's the key shape difference from Klipper v1." }, "printOptions": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/JsonMergePatchRecordstringAdapterPrintOptionBinding" } ], "title": "Per-print-job option bindings — empty today; reserved for future use", "description": "Per-print-job option bindings — empty today; reserved for future use." } }, "description": "JSON Merge Patch style type:\n- `null` removes a key\n- arrays replace the target value (or merge-by-ref for component arrays,\n handled at runtime in `applyCapabilitiesPatch`)\n\nArray elements use `DeepPartial` so callers can supply just the\nfields they're changing (e.g. `{ ref: 'fan_part', controllable: false }`\nwithout restating `role` / `label`). `applyCapabilitiesPatch` merges\ncomponent arrays by `ref` at runtime, so partial elements compose with\nthe base shape correctly. Non-component arrays follow standard\nreplace-the-whole-thing semantics — supply full elements for those.\n\nTests `NonNullable` first so optional fields recurse correctly:\nthe previous `T[P] extends Array` check failed for optional\narrays (the `undefined` union member kept the array branch from\nmatching) and fell through to the object branch, producing\n`Array` shapes that nestia rejects." }, "JsonMergePatchRecordstringPrusaComponentBinding": { "type": "object", "properties": {}, "description": "JSON Merge Patch style type:\n- `null` removes a key\n- arrays replace the target value (or merge-by-ref for component arrays,\n handled at runtime in `applyCapabilitiesPatch`)\n\nArray elements use `DeepPartial` so callers can supply just the\nfields they're changing (e.g. `{ ref: 'fan_part', controllable: false }`\nwithout restating `role` / `label`). `applyCapabilitiesPatch` merges\ncomponent arrays by `ref` at runtime, so partial elements compose with\nthe base shape correctly. Non-component arrays follow standard\nreplace-the-whole-thing semantics — supply full elements for those.\n\nTests `NonNullable` first so optional fields recurse correctly:\nthe previous `T[P] extends Array` check failed for optional\narrays (the `undefined` union member kept the array branch from\nmatching) and fell through to the object branch, producing\n`Array` shapes that nestia rejects.", "additionalProperties": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/JsonMergePatchPrusaComponentBinding" } ] } }, "JsonMergePatchPrusaComponentBinding": { "type": "object", "properties": { "kind": { "oneOf": [ { "type": "null" }, { "const": "chamber" }, { "const": "nozzle" }, { "const": "bed" }, { "const": "fan" } ], "title": "Required for every binding — drives parser/UI dispatch", "description": "Required for every binding — drives parser/UI dispatch." }, "currentField": { "oneOf": [ { "type": "null" }, { "type": "string" } ], "description": "Field on the PrusaLink `printer` object that provides the current\nvalue. Examples: `temp_nozzle`, `temp_bed`, `temp_chamber`,\n`fan_print`, `fan_hotend`." }, "targetField": { "oneOf": [ { "type": "null" }, { "type": "string" } ], "description": "Field on the PrusaLink `printer` object that provides the target /\nsetpoint value. Omit for read-only components (chamber sensors,\nhotend fans)." }, "scale": { "oneOf": [ { "type": "null" }, { "const": "raw" }, { "const": "pwm255" }, { "const": "rpm" } ], "description": "For `fan` components: how the raw PrusaLink value should be normalised\ninto the PrinterStatData fans map (which is `0..100` for controllable\nfans, RPM for hotend fans). `pwm255` divides by 255 and scales to 100;\n`rpm` passes through; `raw` is the default for already-normalised\npercentages." } }, "description": "JSON Merge Patch style type:\n- `null` removes a key\n- arrays replace the target value (or merge-by-ref for component arrays,\n handled at runtime in `applyCapabilitiesPatch`)\n\nArray elements use `DeepPartial` so callers can supply just the\nfields they're changing (e.g. `{ ref: 'fan_part', controllable: false }`\nwithout restating `role` / `label`). `applyCapabilitiesPatch` merges\ncomponent arrays by `ref` at runtime, so partial elements compose with\nthe base shape correctly. Non-component arrays follow standard\nreplace-the-whole-thing semantics — supply full elements for those.\n\nTests `NonNullable` first so optional fields recurse correctly:\nthe previous `T[P] extends Array` check failed for optional\narrays (the `undefined` union member kept the array branch from\nmatching) and fell through to the object branch, producing\n`Array` shapes that nestia rejects." }, "JsonMergePatchSdcpAdapterBindings": { "type": "object", "properties": { "schemaVersion": { "oneOf": [ { "type": "null" }, { "const": 1 } ] }, "components": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/JsonMergePatchRecordstringSdcpComponentBinding" } ] }, "printOptions": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/JsonMergePatchRecordstringAdapterPrintOptionBinding" } ], "title": "Per-print-job option bindings — empty today; reserved for future use", "description": "Per-print-job option bindings — empty today; reserved for future use." } }, "description": "JSON Merge Patch style type:\n- `null` removes a key\n- arrays replace the target value (or merge-by-ref for component arrays,\n handled at runtime in `applyCapabilitiesPatch`)\n\nArray elements use `DeepPartial` so callers can supply just the\nfields they're changing (e.g. `{ ref: 'fan_part', controllable: false }`\nwithout restating `role` / `label`). `applyCapabilitiesPatch` merges\ncomponent arrays by `ref` at runtime, so partial elements compose with\nthe base shape correctly. Non-component arrays follow standard\nreplace-the-whole-thing semantics — supply full elements for those.\n\nTests `NonNullable` first so optional fields recurse correctly:\nthe previous `T[P] extends Array` check failed for optional\narrays (the `undefined` union member kept the array branch from\nmatching) and fell through to the object branch, producing\n`Array` shapes that nestia rejects." }, "JsonMergePatchRecordstringSdcpComponentBinding": { "type": "object", "properties": {}, "description": "JSON Merge Patch style type:\n- `null` removes a key\n- arrays replace the target value (or merge-by-ref for component arrays,\n handled at runtime in `applyCapabilitiesPatch`)\n\nArray elements use `DeepPartial` so callers can supply just the\nfields they're changing (e.g. `{ ref: 'fan_part', controllable: false }`\nwithout restating `role` / `label`). `applyCapabilitiesPatch` merges\ncomponent arrays by `ref` at runtime, so partial elements compose with\nthe base shape correctly. Non-component arrays follow standard\nreplace-the-whole-thing semantics — supply full elements for those.\n\nTests `NonNullable` first so optional fields recurse correctly:\nthe previous `T[P] extends Array` check failed for optional\narrays (the `undefined` union member kept the array branch from\nmatching) and fell through to the object branch, producing\n`Array` shapes that nestia rejects.", "additionalProperties": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/JsonMergePatchSdcpComponentBinding" } ] } }, "JsonMergePatchSdcpComponentBinding": { "type": "object", "properties": { "kind": { "oneOf": [ { "type": "null" }, { "const": "chamber" }, { "const": "nozzle" }, { "const": "bed" }, { "const": "fan" }, { "const": "light" } ], "title": "Required for every binding — drives parser/UI dispatch", "description": "Required for every binding — drives parser/UI dispatch." }, "currentPath": { "oneOf": [ { "type": "null" }, { "type": "string" } ], "description": "Dotted path relative to the SDCP `Data.Status` object for the current\nvalue. Example: `TempOfNozzle`, `CurrentFanSpeed.ModelFan`,\n`LightStatus.SecondLight`." }, "targetPath": { "oneOf": [ { "type": "null" }, { "type": "string" } ], "title": "Dotted path relative to `Data.Status` for the target / setpoint value", "description": "Dotted path relative to `Data.Status` for the target / setpoint value.\nOmit for components with no controllable setpoint (chamber sensors,\nlights, auxiliary-read-only fans)." }, "scale": { "oneOf": [ { "type": "null" }, { "const": "raw" }, { "const": "pwm255" } ], "description": "For `fan` components: how the raw SDCP value should be normalised into\nthe PrinterStatData fans map (which is `0..100`). Most SDCP printers\nreport 0..255 PWM, so `pwm255` is the common default; `raw` passes the\nvalue through unchanged." }, "onValue": { "oneOf": [ { "type": "null" }, { "type": "string" } ], "description": "For `light` components: the truthy value (or comma-separated values)\nthe parser matches against the current-path read to decide whether\nthe light is on. SDCP's `LightStatus.SecondLight` uses `1` for on,\n`0` for off; this value is compared loosely (`String(value) === onValue`)." } }, "description": "JSON Merge Patch style type:\n- `null` removes a key\n- arrays replace the target value (or merge-by-ref for component arrays,\n handled at runtime in `applyCapabilitiesPatch`)\n\nArray elements use `DeepPartial` so callers can supply just the\nfields they're changing (e.g. `{ ref: 'fan_part', controllable: false }`\nwithout restating `role` / `label`). `applyCapabilitiesPatch` merges\ncomponent arrays by `ref` at runtime, so partial elements compose with\nthe base shape correctly. Non-component arrays follow standard\nreplace-the-whole-thing semantics — supply full elements for those.\n\nTests `NonNullable` first so optional fields recurse correctly:\nthe previous `T[P] extends Array` check failed for optional\narrays (the `undefined` union member kept the array branch from\nmatching) and fell through to the object branch, producing\n`Array` shapes that nestia rejects." }, "JsonMergePatchElegooMqttAdapterBindings": { "type": "object", "properties": { "schemaVersion": { "oneOf": [ { "type": "null" }, { "const": 1 } ] }, "components": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/JsonMergePatchRecordstringElegooMqttComponentBinding" } ] }, "printOptions": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/JsonMergePatchRecordstringAdapterPrintOptionBinding" } ], "title": "Per-print-job option bindings — empty today; reserved for future use", "description": "Per-print-job option bindings — empty today; reserved for future use." } }, "description": "JSON Merge Patch style type:\n- `null` removes a key\n- arrays replace the target value (or merge-by-ref for component arrays,\n handled at runtime in `applyCapabilitiesPatch`)\n\nArray elements use `DeepPartial` so callers can supply just the\nfields they're changing (e.g. `{ ref: 'fan_part', controllable: false }`\nwithout restating `role` / `label`). `applyCapabilitiesPatch` merges\ncomponent arrays by `ref` at runtime, so partial elements compose with\nthe base shape correctly. Non-component arrays follow standard\nreplace-the-whole-thing semantics — supply full elements for those.\n\nTests `NonNullable` first so optional fields recurse correctly:\nthe previous `T[P] extends Array` check failed for optional\narrays (the `undefined` union member kept the array branch from\nmatching) and fell through to the object branch, producing\n`Array` shapes that nestia rejects." }, "JsonMergePatchRecordstringElegooMqttComponentBinding": { "type": "object", "properties": {}, "description": "JSON Merge Patch style type:\n- `null` removes a key\n- arrays replace the target value (or merge-by-ref for component arrays,\n handled at runtime in `applyCapabilitiesPatch`)\n\nArray elements use `DeepPartial` so callers can supply just the\nfields they're changing (e.g. `{ ref: 'fan_part', controllable: false }`\nwithout restating `role` / `label`). `applyCapabilitiesPatch` merges\ncomponent arrays by `ref` at runtime, so partial elements compose with\nthe base shape correctly. Non-component arrays follow standard\nreplace-the-whole-thing semantics — supply full elements for those.\n\nTests `NonNullable` first so optional fields recurse correctly:\nthe previous `T[P] extends Array` check failed for optional\narrays (the `undefined` union member kept the array branch from\nmatching) and fell through to the object branch, producing\n`Array` shapes that nestia rejects.", "additionalProperties": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/JsonMergePatchElegooMqttComponentBinding" } ] } }, "JsonMergePatchElegooMqttComponentBinding": { "type": "object", "properties": { "kind": { "oneOf": [ { "type": "null" }, { "const": "chamber" }, { "const": "nozzle" }, { "const": "bed" }, { "const": "fan" }, { "const": "light" } ], "title": "Required for every binding — drives parser/UI dispatch", "description": "Required for every binding — drives parser/UI dispatch." }, "currentPath": { "oneOf": [ { "type": "null" }, { "type": "string" } ], "title": "Dotted path relative to the CC2 `result` object for the current value", "description": "Dotted path relative to the CC2 `result` object for the current value.\nExamples: `extruder.temperature`, `heater_bed.temperature`,\n`fans.fan.speed`, `led.status`." }, "targetPath": { "oneOf": [ { "type": "null" }, { "type": "string" } ], "description": "Dotted path relative to `result` for the target / setpoint value. Omit\nfor components with no controllable setpoint (chamber sensor, lights,\nread-only fans)." }, "scale": { "oneOf": [ { "type": "null" }, { "const": "raw" }, { "const": "pwm255" } ], "description": "For `fan` components: how the raw CC2 value should be normalised into\nthe PrinterStatData fans map (which is `0..100`). CC2 reports fan\nspeed as 0..255 PWM, so `pwm255` is the default; `raw` passes the value\nthrough unchanged." }, "onValue": { "oneOf": [ { "type": "null" }, { "type": "string" } ], "description": "For `light` components: the truthy value the parser matches against\nthe current-path read to decide whether the light is on. CC2's\n`led.status` is `1` for on / `0` for off (and may also surface 0..255\nbrightness — TODO: confirm with hardware once the MQTT client lands)." } }, "description": "JSON Merge Patch style type:\n- `null` removes a key\n- arrays replace the target value (or merge-by-ref for component arrays,\n handled at runtime in `applyCapabilitiesPatch`)\n\nArray elements use `DeepPartial` so callers can supply just the\nfields they're changing (e.g. `{ ref: 'fan_part', controllable: false }`\nwithout restating `role` / `label`). `applyCapabilitiesPatch` merges\ncomponent arrays by `ref` at runtime, so partial elements compose with\nthe base shape correctly. Non-component arrays follow standard\nreplace-the-whole-thing semantics — supply full elements for those.\n\nTests `NonNullable` first so optional fields recurse correctly:\nthe previous `T[P] extends Array` check failed for optional\narrays (the `undefined` union member kept the array branch from\nmatching) and fell through to the object branch, producing\n`Array` shapes that nestia rejects." }, "JsonMergePatchOctoprintAdapterBindings": { "type": "object", "properties": { "schemaVersion": { "oneOf": [ { "type": "null" }, { "const": 1 } ] }, "components": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/JsonMergePatchRecordstringOctoprintComponentBinding" } ], "description": "Component bindings keyed by Printago ref. Used by `OctoprintStateParser`\nto turn OctoPrint's `temperature` map into ref-indexed PrinterStatData\nentries. OctoPrint's command surface is API-level (REST), so this adapter\nhas no `commands` map — same shape as the Prusa adapter." }, "printOptions": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/JsonMergePatchRecordstringAdapterPrintOptionBinding" } ], "title": "Per-print-job option bindings — empty today; reserved for future use", "description": "Per-print-job option bindings — empty today; reserved for future use." } }, "description": "JSON Merge Patch style type:\n- `null` removes a key\n- arrays replace the target value (or merge-by-ref for component arrays,\n handled at runtime in `applyCapabilitiesPatch`)\n\nArray elements use `DeepPartial` so callers can supply just the\nfields they're changing (e.g. `{ ref: 'fan_part', controllable: false }`\nwithout restating `role` / `label`). `applyCapabilitiesPatch` merges\ncomponent arrays by `ref` at runtime, so partial elements compose with\nthe base shape correctly. Non-component arrays follow standard\nreplace-the-whole-thing semantics — supply full elements for those.\n\nTests `NonNullable` first so optional fields recurse correctly:\nthe previous `T[P] extends Array` check failed for optional\narrays (the `undefined` union member kept the array branch from\nmatching) and fell through to the object branch, producing\n`Array` shapes that nestia rejects." }, "JsonMergePatchRecordstringOctoprintComponentBinding": { "type": "object", "properties": {}, "description": "JSON Merge Patch style type:\n- `null` removes a key\n- arrays replace the target value (or merge-by-ref for component arrays,\n handled at runtime in `applyCapabilitiesPatch`)\n\nArray elements use `DeepPartial` so callers can supply just the\nfields they're changing (e.g. `{ ref: 'fan_part', controllable: false }`\nwithout restating `role` / `label`). `applyCapabilitiesPatch` merges\ncomponent arrays by `ref` at runtime, so partial elements compose with\nthe base shape correctly. Non-component arrays follow standard\nreplace-the-whole-thing semantics — supply full elements for those.\n\nTests `NonNullable` first so optional fields recurse correctly:\nthe previous `T[P] extends Array` check failed for optional\narrays (the `undefined` union member kept the array branch from\nmatching) and fell through to the object branch, producing\n`Array` shapes that nestia rejects.", "additionalProperties": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/JsonMergePatchOctoprintComponentBinding" } ] } }, "JsonMergePatchOctoprintComponentBinding": { "type": "object", "properties": { "kind": { "oneOf": [ { "type": "null" }, { "const": "chamber" }, { "const": "nozzle" }, { "const": "bed" } ], "title": "Required for every binding — drives parser/UI dispatch", "description": "Required for every binding — drives parser/UI dispatch." }, "sensor": { "oneOf": [ { "type": "null" }, { "type": "string" } ], "description": "Key into OctoPrint's `temperature` map. Examples: `tool0`, `tool1`,\n`bed`, `chamber`. The parser reads `temperature[sensor].actual` for the\ncurrent value and `temperature[sensor].target` for the setpoint." } }, "description": "JSON Merge Patch style type:\n- `null` removes a key\n- arrays replace the target value (or merge-by-ref for component arrays,\n handled at runtime in `applyCapabilitiesPatch`)\n\nArray elements use `DeepPartial` so callers can supply just the\nfields they're changing (e.g. `{ ref: 'fan_part', controllable: false }`\nwithout restating `role` / `label`). `applyCapabilitiesPatch` merges\ncomponent arrays by `ref` at runtime, so partial elements compose with\nthe base shape correctly. Non-component arrays follow standard\nreplace-the-whole-thing semantics — supply full elements for those.\n\nTests `NonNullable` first so optional fields recurse correctly:\nthe previous `T[P] extends Array` check failed for optional\narrays (the `undefined` union member kept the array branch from\nmatching) and fell through to the object branch, producing\n`Array` shapes that nestia rejects." }, "SetProviderConfig": { "type": "object", "properties": { "printerIds": { "type": "array", "items": { "type": "string", "pattern": "^[a-z0-9]{24}$" } }, "providerConfig": { "$ref": "#/components/schemas/BambuConfig" }, "machineUserProfileId": { "oneOf": [ { "type": "null" }, { "type": "string", "pattern": "^[a-z0-9]{24}$" } ] }, "machineSystemProfileId": { "oneOf": [ { "type": "null" }, { "type": "number" } ] }, "processUserProfileId": { "oneOf": [ { "type": "null" }, { "type": "string", "pattern": "^[a-z0-9]{24}$" } ] }, "processSystemProfileId": { "oneOf": [ { "type": "null" }, { "type": "number" } ] } }, "required": [ "printerIds", "providerConfig", "machineUserProfileId", "machineSystemProfileId", "processUserProfileId", "processSystemProfileId" ] }, "ConfirmReadyRequest": { "type": "object", "properties": { "ready": { "type": "boolean" }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^[a-z0-9]{24}$" } } }, "required": [ "ready", "ids" ] }, "EnabledConfig": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^[a-z0-9]{24}$" } } }, "required": [ "enabled", "ids" ] }, "ContinuousPrintConfig": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "jobLimit": { "oneOf": [ { "type": "null" }, { "type": "number", "minimum": 1 } ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^[a-z0-9]{24}$" } } }, "required": [ "enabled", "ids" ] }, "providerstringundefineddeviceIdstringundefinedproviderConfigstringundefinedmachineUserProfileIdstringundefinedmachineSystemProfileIdstringundefined...31more...updatedAtstringundefinedQuerySettings...": { "type": "object", "properties": { "provider": { "type": "string" }, "deviceId": { "type": "string" }, "providerConfig": { "type": "string" }, "machineUserProfileId": { "type": "string" }, "machineSystemProfileId": { "type": "string" }, "processUserProfileId": { "type": "string" }, "processSystemProfileId": { "type": "string" }, "name": { "type": "string" }, "nozzleDiameter": { "type": "string" }, "metadata": { "type": "string" }, "proxyClientId": { "type": "string" }, "commMethod": { "type": "string" }, "enabled": { "type": "string" }, "tags": { "type": "string" }, "confirmedReady": { "type": "string" }, "isAvailable": { "type": "string" }, "isOnline": { "type": "string" }, "printingJobId": { "type": "string" }, "lastPrintedAt": { "type": "string" }, "integrationId": { "type": "string" }, "integrationType": { "type": "string" }, "continuousPrint": { "type": "string" }, "fabmaticRemainingJobs": { "type": "string" }, "modelName": { "type": "string", "description": "Human-readable model name (e.g. \"P1S\", \"Snapmaker U1\", \"Prusa CORE One\")" }, "vendorName": { "type": "string", "description": "Vendor/manufacturer name (e.g. \"Bambu Lab\", \"Prusa\", \"Snapmaker\")" }, "vendorModelId": { "type": "string" }, "printerCapabilityPatch": { "type": "string", "title": "Per-printer capability override applied last (web Advanced Capabilities panel)", "description": "Per-printer capability override applied last (web Advanced Capabilities panel)." }, "printerAdapterBindingsPatch": { "type": "string", "title": "Per-printer adapter binding override applied last", "description": "Per-printer adapter binding override applied last." }, "lifetimePrintHours": { "type": "string" }, "lifetimeJobCount": { "type": "string" }, "isInMaintenance": { "type": "string" }, "lastMaintenanceOfflineAt": { "type": "string" }, "lastMaintenanceOnlineAt": { "type": "string" }, "id": { "type": "string" }, "storeId": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "sort": { "type": "string", "title": "Sort", "description": "Sort specification in format \"field:asc,field2:desc\"" }, "limit": { "type": "number", "minimum": 1, "maximum": 1000, "title": "Limit", "description": "Maximum number of results to return (default: 100, max: 1000)" }, "offset": { "type": "number", "minimum": 0, "title": "Offset", "description": "Number of results to skip for pagination" }, "fields": { "type": "string", "title": "Fields", "description": "Comma-separated list of fields to return" }, "include": { "type": "string", "title": "Include", "description": "Comma-separated list of relations to include (max 4, max 2 levels deep).\nExample: \"linkedParts,linkedParts.part,folder\"" }, "meta": { "type": "boolean", "title": "Meta", "description": "If true, returns response with metadata (total, count, hasMore, etc.)" }, "hints": { "type": "boolean", "title": "Hints", "description": "If true, returns AI-friendly hints about available actions. Implies meta=true." } } }, "SearchQueryDtoPrinter": { "type": "object", "properties": { "filter": { "oneOf": [ { "$ref": "#/components/schemas/LogicalConditionPrinter" }, { "$ref": "#/components/schemas/FieldConditionPrinter" } ], "title": "Filter", "description": "Complex filter conditions using logical and field operators.\nAvailable field operators: eq, ne, gt, gte, lt, lte, contains, startsWith, endsWith, in, notIn, isNull, between.\nUsage example: {\"filter\": {\"and\": [{\"name\": {\"contains\": \"benchy\"}}, {\"or\": [{\"type\": {\"eq\": \"3mf\"}}, {\"type\": {\"eq\": \"gcode3mf\"}}]}}}" }, "sort": { "type": "string", "title": "Sort", "description": "Sort specification in format \"field:asc,field2:desc\"" }, "limit": { "type": "number", "minimum": 1, "maximum": 1000, "title": "Limit", "description": "Maximum number of results to return (default: 100, max: 1000)" }, "offset": { "type": "number", "minimum": 0, "title": "Offset", "description": "Number of results to skip for pagination" }, "fields": { "type": "string", "title": "Fields", "description": "Comma-separated list of fields to return" }, "include": { "type": "string", "title": "Include", "description": "Comma-separated list of relations to include (max 4, max 2 levels deep).\nExample: \"linkedParts,linkedParts.part,folder\"" }, "meta": { "type": "boolean", "title": "Meta", "description": "If true, returns response with metadata (total, count, hasMore, etc.)" }, "hints": { "type": "boolean", "title": "Hints", "description": "If true, returns AI-friendly hints about available actions. Implies meta=true." } }, "title": "Search Query", "description": "Complete search request with filter conditions and query settings" }, "LogicalConditionPrinter": { "type": "object", "properties": { "and": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/LogicalConditionPrinter" }, { "$ref": "#/components/schemas/FieldConditionPrinter" } ] }, "title": "AND Conditions", "description": "All conditions must be true" }, "or": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/LogicalConditionPrinter" }, { "$ref": "#/components/schemas/FieldConditionPrinter" } ] }, "title": "OR Conditions", "description": "At least one condition must be true" } }, "title": "Logical Condition", "description": "Logical operators for combining multiple filter conditions" }, "FieldConditionPrinter": { "type": "object", "properties": { "provider": { "$ref": "#/components/schemas/FieldOperators" }, "deviceId": { "$ref": "#/components/schemas/FieldOperators" }, "providerConfig": { "$ref": "#/components/schemas/FieldOperators" }, "machineUserProfileId": { "$ref": "#/components/schemas/FieldOperators" }, "machineSystemProfileId": { "$ref": "#/components/schemas/FieldOperators" }, "processUserProfileId": { "$ref": "#/components/schemas/FieldOperators" }, "processSystemProfileId": { "$ref": "#/components/schemas/FieldOperators" }, "name": { "$ref": "#/components/schemas/FieldOperators" }, "nozzleDiameter": { "$ref": "#/components/schemas/FieldOperators" }, "metadata": { "$ref": "#/components/schemas/FieldOperators" }, "proxyClientId": { "$ref": "#/components/schemas/FieldOperators" }, "commMethod": { "$ref": "#/components/schemas/FieldOperators" }, "enabled": { "$ref": "#/components/schemas/FieldOperators" }, "tags": { "$ref": "#/components/schemas/FieldOperators" }, "confirmedReady": { "$ref": "#/components/schemas/FieldOperators" }, "isAvailable": { "$ref": "#/components/schemas/FieldOperators" }, "isOnline": { "$ref": "#/components/schemas/FieldOperators" }, "printingJobId": { "$ref": "#/components/schemas/FieldOperators" }, "lastPrintedAt": { "$ref": "#/components/schemas/FieldOperators" }, "integrationId": { "$ref": "#/components/schemas/FieldOperators" }, "integrationType": { "$ref": "#/components/schemas/FieldOperators" }, "continuousPrint": { "$ref": "#/components/schemas/FieldOperators" }, "fabmaticRemainingJobs": { "$ref": "#/components/schemas/FieldOperators" }, "modelName": { "$ref": "#/components/schemas/FieldOperators", "description": "Human-readable model name (e.g. \"P1S\", \"Snapmaker U1\", \"Prusa CORE One\")" }, "vendorName": { "$ref": "#/components/schemas/FieldOperators", "description": "Vendor/manufacturer name (e.g. \"Bambu Lab\", \"Prusa\", \"Snapmaker\")" }, "vendorModelId": { "$ref": "#/components/schemas/FieldOperators" }, "printerCapabilityPatch": { "$ref": "#/components/schemas/FieldOperators", "title": "Per-printer capability override applied last (web Advanced Capabilities panel)", "description": "Per-printer capability override applied last (web Advanced Capabilities panel)." }, "printerAdapterBindingsPatch": { "$ref": "#/components/schemas/FieldOperators", "title": "Per-printer adapter binding override applied last", "description": "Per-printer adapter binding override applied last." }, "lifetimePrintHours": { "$ref": "#/components/schemas/FieldOperators" }, "lifetimeJobCount": { "$ref": "#/components/schemas/FieldOperators" }, "isInMaintenance": { "$ref": "#/components/schemas/FieldOperators" }, "lastMaintenanceOfflineAt": { "$ref": "#/components/schemas/FieldOperators" }, "lastMaintenanceOnlineAt": { "$ref": "#/components/schemas/FieldOperators" }, "id": { "$ref": "#/components/schemas/FieldOperators" }, "storeId": { "$ref": "#/components/schemas/FieldOperators" }, "createdAt": { "$ref": "#/components/schemas/FieldOperators" }, "updatedAt": { "$ref": "#/components/schemas/FieldOperators" } }, "title": "Field Condition", "description": "Field-based filter conditions where keys are field names and values are field operators" }, "PrinterLatestSnapshot": { "type": "object", "properties": { "url": { "type": "string", "description": "Short-lived signed download URL for the most recent camera snapshot\nFuse uploaded for this printer. Refresh by calling this endpoint\nagain before `expiresAt`." }, "expiresAt": { "type": "number", "title": "Unix epoch milliseconds at which `url` stops working", "description": "Unix epoch milliseconds at which `url` stops working." } }, "required": [ "url", "expiresAt" ] }, "ResolvePrinterCapabilitiesResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/ResolvedPrinterCapabilitiesItem" } } }, "required": [ "items" ] }, "ResolvedPrinterCapabilitiesItem": { "type": "object", "properties": { "printerId": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "capabilities": { "oneOf": [ { "type": "null" }, { "type": "object", "properties": { "nozzles": { "type": "array", "items": { "type": "object", "properties": { "temperature": { "type": "object", "properties": { "read": { "type": "boolean" }, "set": { "type": "boolean" } } }, "extrude": { "type": "boolean" }, "toolRef": { "type": "string" }, "ref": { "type": "string", "title": "Logical reference, unique within its array. ASCII, lowercase, deterministic", "description": "Logical reference, unique within its array. ASCII, lowercase, deterministic." }, "label": { "type": "string", "description": "Human-readable display name" }, "kind": { "type": "string", "description": "Optional vendor/extensible subtype when the base role is not enough" } } } }, "tools": { "type": "array", "items": { "type": "object", "properties": { "selectable": { "type": "boolean" }, "nozzleRefs": { "type": "array", "items": { "type": "string" } }, "fanRefs": { "type": "array", "items": { "type": "string" } }, "sensorRefs": { "type": "array", "items": { "type": "string" } }, "ref": { "type": "string", "title": "Logical reference, unique within its array. ASCII, lowercase, deterministic", "description": "Logical reference, unique within its array. ASCII, lowercase, deterministic." }, "label": { "type": "string", "description": "Human-readable display name" }, "kind": { "type": "string", "description": "Optional vendor/extensible subtype when the base role is not enough" } } } }, "fans": { "type": "array", "items": { "type": "object", "properties": { "role": { "oneOf": [ { "const": "part" }, { "const": "aux" }, { "const": "chamber" }, { "const": "hotend" }, { "const": "exhaust" }, { "type": "object", "properties": { "length": { "type": "number", "title": "Returns the length of a String object", "description": "Returns the length of a String object." } }, "additionalProperties": { "type": "string" } } ] }, "controllable": { "type": "boolean" }, "reportsSpeed": { "type": "boolean", "description": "Whether the printer reports back a live fan speed. Defaults to true\n(omitted). Set false for write-only fans (e.g. OctoPrint, whose REST API\naccepts M106 but never surfaces a speed) so diagnostics skip the readback\nverification instead of failing a check they can't perform." }, "nozzleRef": { "type": "string" }, "toolRef": { "type": "string" }, "ref": { "type": "string", "title": "Logical reference, unique within its array. ASCII, lowercase, deterministic", "description": "Logical reference, unique within its array. ASCII, lowercase, deterministic." }, "label": { "type": "string", "description": "Human-readable display name" }, "kind": { "type": "string", "description": "Optional vendor/extensible subtype when the base role is not enough" } } } }, "lights": { "type": "array", "items": { "type": "object", "properties": { "role": { "oneOf": [ { "const": "chamber" }, { "const": "work" }, { "const": "indicator" }, { "const": "strip" }, { "type": "object", "properties": { "length": { "type": "number", "title": "Returns the length of a String object", "description": "Returns the length of a String object." } }, "additionalProperties": { "type": "string" } } ] }, "dimmable": { "type": "boolean" }, "ref": { "type": "string", "title": "Logical reference, unique within its array. ASCII, lowercase, deterministic", "description": "Logical reference, unique within its array. ASCII, lowercase, deterministic." }, "label": { "type": "string", "description": "Human-readable display name" }, "kind": { "type": "string", "description": "Optional vendor/extensible subtype when the base role is not enough" } } } }, "sensors": { "type": "array", "items": { "type": "object", "properties": { "role": { "oneOf": [ { "const": "lidar" }, { "const": "filament_runout" }, { "const": "door" }, { "const": "accelerometer" }, { "const": "bed_mesh" }, { "type": "object", "properties": { "length": { "type": "number", "title": "Returns the length of a String object", "description": "Returns the length of a String object." } }, "additionalProperties": { "type": "string" } } ] }, "nozzleRef": { "type": "string" }, "toolRef": { "type": "string" }, "ref": { "type": "string", "title": "Logical reference, unique within its array. ASCII, lowercase, deterministic", "description": "Logical reference, unique within its array. ASCII, lowercase, deterministic." }, "label": { "type": "string", "description": "Human-readable display name" }, "kind": { "type": "string", "description": "Optional vendor/extensible subtype when the base role is not enough" } } } }, "beds": { "type": "array", "items": { "type": "object", "properties": { "temperature": { "type": "object", "properties": { "read": { "type": "boolean" }, "set": { "type": "boolean" } } }, "hasMesh": { "type": "boolean" }, "ref": { "type": "string", "title": "Logical reference, unique within its array. ASCII, lowercase, deterministic", "description": "Logical reference, unique within its array. ASCII, lowercase, deterministic." }, "label": { "type": "string", "description": "Human-readable display name" }, "kind": { "type": "string", "description": "Optional vendor/extensible subtype when the base role is not enough" } } } }, "chambers": { "type": "array", "items": { "type": "object", "properties": { "temperature": { "type": "object", "properties": { "read": { "type": "boolean" }, "set": { "type": "boolean" } } }, "ref": { "type": "string", "title": "Logical reference, unique within its array. ASCII, lowercase, deterministic", "description": "Logical reference, unique within its array. ASCII, lowercase, deterministic." }, "label": { "type": "string", "description": "Human-readable display name" }, "kind": { "type": "string", "description": "Optional vendor/extensible subtype when the base role is not enough" } } } }, "axes": { "type": "array", "items": { "type": "object", "properties": { "axis": { "oneOf": [ { "const": "x" }, { "const": "y" }, { "const": "z" } ] }, "move": { "type": "boolean" }, "home": { "type": "boolean" }, "flipped": { "type": "boolean" }, "ref": { "type": "string", "title": "Logical reference, unique within its array. ASCII, lowercase, deterministic", "description": "Logical reference, unique within its array. ASCII, lowercase, deterministic." }, "label": { "type": "string", "description": "Human-readable display name" }, "kind": { "type": "string", "description": "Optional vendor/extensible subtype when the base role is not enough" } } } }, "filaments": { "type": "array", "items": { "type": "object", "properties": { "canReadFilament": { "type": "boolean", "title": "True if printer hardware can read filament info from this source", "description": "True if printer hardware can read filament info from this source." }, "canLoad": { "type": "boolean", "title": "True if printer can auto-load filament into this source", "description": "True if printer can auto-load filament into this source." }, "canUnload": { "type": "boolean", "title": "True if printer can auto-unload filament", "description": "True if printer can auto-unload filament." }, "ref": { "type": "string", "title": "Logical reference, unique within its array. ASCII, lowercase, deterministic", "description": "Logical reference, unique within its array. ASCII, lowercase, deterministic." }, "label": { "type": "string", "description": "Human-readable display name" }, "kind": { "type": "string", "description": "Optional vendor/extensible subtype when the base role is not enough" } } }, "description": "Directly-fed filament sources. An array because some printers feed\nmultiple positions simultaneously (Bambu external bay = 2, Snapmaker\nU1 = 4, Bambu H2D = 2+). Each entry is one loadable position.\nAMS / MMU / ERCF / CFS / toolchanger live separately under\n`peripherals` and are presented alongside these in the UI's\nFilaments view." }, "cameras": { "type": "array", "items": { "type": "object", "properties": { "protocol": { "oneOf": [ { "const": "mjpeg-bambu" }, { "const": "rtsps-bambu" }, { "const": "webrtc" }, { "const": "rtsp" }, { "const": "rtsps" }, { "const": "mjpeg-http" }, { "const": "http-snapshot" }, { "const": "http-snapshot-poll" } ] }, "mounting": { "oneOf": [ { "const": "builtin" }, { "const": "external" } ], "title": "`builtin`: seeded by the capability set, locked in the UI", "description": "`builtin`: seeded by the capability set, locked in the UI.\n`external`: user-attached; editable + removable via printer config." }, "url": { "type": "string", "description": "Literal stream URL. Required for non-Bambu protocols, EXCEPT for\n`mjpeg-http` cameras whose endpoint can be synthesized from\n`printer.ip + port` (path-agnostic MJPEG, e.g. Elegoo Centauri\nCarbon 2 on `:8080`). Set `url` when the camera is at a third-party\nabsolute address; otherwise just set `port` and let the go2rtc\ngenerator build `http://${printer.ip}:${port}/`." }, "port": { "type": "number", "title": "Override default port for the protocol", "description": "Override default port for the protocol." }, "path": { "type": "string", "description": "Override the URL path for `mjpeg-http` (default `/`). Used when the\nstream sits behind a fixed path on the printer's web server — e.g.\nMainsail/Fluidd-style `/webcam/?action=stream` for camera-streamer\nor mjpg-streamer. Combined with `printer.ip + port` to build the\nfull URL when `url` isn't set." }, "auth": { "type": "string", "description": "Auth credentials for the stream — `Bearer ...`, `user:pass`, or a\nquery-string fragment. Bambu protocols ignore this; their auth is\nderived from `printer.accessCode`." }, "role": { "oneOf": [ { "const": "overhead" }, { "const": "chamber" }, { "const": "bed" }, { "const": "toolhead" }, { "type": "object", "properties": { "length": { "type": "number", "title": "Returns the length of a String object", "description": "Returns the length of a String object." } }, "additionalProperties": { "type": "string" } } ], "title": "UX-only role for grouping/labeling", "description": "UX-only role for grouping/labeling." }, "snapshots": { "type": "boolean", "title": "Whether to capture periodic snapshots. Defaults true if unset", "description": "Whether to capture periodic snapshots. Defaults true if unset." }, "timelapse": { "type": "boolean", "title": "Whether to record timelapses. Defaults true if unset", "description": "Whether to record timelapses. Defaults true if unset." }, "primary": { "type": "boolean", "description": "When true, this is the printer's primary camera: it owns the bare\n`printer.id` go2rtc stream key, so the live dashboard/printer tile,\nperiodic snapshots, the print-completion thumbnail, and timelapses\nall read from it instead of the built-in camera. At most one camera\nper printer should set this; when none do, the first camera\n(index 0, normally the built-in) is the implicit primary." }, "webrtcSignaling": { "type": "object", "properties": { "flavor": { "oneOf": [ { "const": "whep" }, { "const": "creality-base64-json" }, { "const": "go2rtc-ws" } ] }, "path": { "type": "string", "title": "Endpoint path or full URL for the signaling request", "description": "Endpoint path or full URL for the signaling request." } }, "description": "SDP-exchange config for `protocol: 'webrtc'`. Required when protocol\nis `'webrtc'`; ignored otherwise. The transport itself is always\nstandard WebRTC; this only describes how the offer/answer get traded.\n\nFor `creality-base64-json`, the signaling URL is built from\n`printer.ip:port` + `path` (e.g. http://192.168.1.26:8000/call/webrtc_local).\nFor `whep`, `path` may be a full URL or a path appended to the camera's\nbase URL." }, "ref": { "type": "string", "title": "Logical reference, unique within its array. ASCII, lowercase, deterministic", "description": "Logical reference, unique within its array. ASCII, lowercase, deterministic." }, "label": { "type": "string", "description": "Human-readable display name" }, "kind": { "type": "string", "description": "Optional vendor/extensible subtype when the base role is not enough" } } }, "description": "Cameras attached to the printer. Built-in (`mounting:'builtin'`)\ncameras come from the printer's capability set; external IP/RTSP\ncameras (`mounting:'external'`) are added via printer config.\n\nReplaces the legacy `getCameraProtocol(modelCode)` lookup — all\ncamera config flows through this array." }, "peripherals": { "type": "array", "items": { "type": "object", "properties": { "type": { "oneOf": [ { "const": "ercf" }, { "const": "mmu" }, { "const": "toolchanger" }, { "const": "ams" }, { "type": "object", "properties": { "length": { "type": "number", "title": "Returns the length of a String object", "description": "Returns the length of a String object." } }, "additionalProperties": { "type": "string" } } ] }, "maxUnits": { "type": "number" }, "slotsPerUnit": { "type": "number" }, "minSlotsPerUnit": { "type": "number" }, "maxSlotsPerUnit": { "type": "number" }, "canReadFilament": { "type": "boolean" }, "canLoad": { "type": "boolean" }, "canUnload": { "type": "boolean" }, "ref": { "type": "string", "title": "Logical reference, unique within its array. ASCII, lowercase, deterministic", "description": "Logical reference, unique within its array. ASCII, lowercase, deterministic." }, "label": { "type": "string", "description": "Human-readable display name" }, "kind": { "type": "string", "description": "Optional vendor/extensible subtype when the base role is not enough" } } } }, "printing": { "type": "object", "properties": { "start": { "type": "boolean" }, "pause": { "type": "boolean" }, "resume": { "type": "boolean" }, "stop": { "type": "boolean" }, "skipObjects": { "type": "boolean" } } }, "filament": { "type": "object", "properties": { "setInfo": { "type": "boolean" }, "read": { "type": "boolean" }, "dynamicSlots": { "type": "boolean" } } }, "files": { "type": "object", "properties": { "upload": { "type": "boolean" }, "list": { "type": "boolean" } } }, "gcode": { "type": "boolean" }, "printOptions": { "type": "array", "items": { "type": "object", "properties": { "kind": { "oneOf": [ { "const": "boolean" }, { "const": "enum" } ] }, "default": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ], "title": "UI default when the stored providerConfig is null / missing the key", "description": "UI default when the stored providerConfig is null / missing the key." }, "choices": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "label": { "type": "string" } } }, "title": "For `kind: \"enum\"`: allowed values with display labels", "description": "For `kind: \"enum\"`: allowed values with display labels." }, "description": { "type": "string", "title": "Tooltip help text rendered next to the label", "description": "Tooltip help text rendered next to the label." }, "ref": { "type": "string", "title": "Logical reference, unique within its array. ASCII, lowercase, deterministic", "description": "Logical reference, unique within its array. ASCII, lowercase, deterministic." }, "label": { "type": "string", "description": "Human-readable display name" } } } } } } ] } }, "required": [ "printerId", "capabilities" ] }, "ResolvePrinterCapabilitiesRequest": { "type": "object", "properties": { "printerIds": { "type": "array", "items": { "type": "string", "pattern": "^[a-z0-9]{24}$" } } }, "required": [ "printerIds" ] }, "UpdateManyRequestPrinterUpdate": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "pattern": "^[a-z0-9]{24}$" } }, "update": { "$ref": "#/components/schemas/PartialPrinterUpdate" } }, "required": [ "ids", "update" ] }, "PartialPrinterUpdate": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 1024 }, "metadata": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/BambuPrinterMetadata" }, { "$ref": "#/components/schemas/KlipperMetadata" }, { "$ref": "#/components/schemas/PrusaMetadata" }, { "$ref": "#/components/schemas/SdcpMetadata" }, { "$ref": "#/components/schemas/OctoPrintMetadata" } ] }, "integrationId": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "integrationType": { "oneOf": [ { "type": "null" }, { "const": "bambulab" }, { "const": "etsy" }, { "const": "shopify" }, { "const": "ebay" }, { "const": "tiktok-shop" }, { "const": "filametrics" } ] }, "tags": { "type": "array", "items": { "type": "string" } }, "deviceId": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "nozzleDiameter": { "type": "string" }, "enabled": { "type": "boolean" }, "commMethod": { "oneOf": [ { "type": "null" }, { "const": "bambu-global-mqtt" }, { "const": "bambu-cloud-v2" }, { "const": "octoprint-mqtt" }, { "const": "fuse" } ] }, "vendorModelId": { "oneOf": [ { "type": "null" }, { "type": "number" } ] }, "printerCapabilityPatch": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/JsonMergePatchPrinterCommCapabilities" } ], "title": "Per-printer capability override applied last (web Advanced Capabilities panel)", "description": "Per-printer capability override applied last (web Advanced Capabilities panel)." }, "printerAdapterBindingsPatch": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/JsonMergePatchPrinterAdapterBindings" } ], "title": "Per-printer adapter binding override applied last", "description": "Per-printer adapter binding override applied last." } }, "description": "Make all properties in T optional" }, "PartialPrinterUpdateidstring": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 1024 }, "metadata": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/BambuPrinterMetadata" }, { "$ref": "#/components/schemas/KlipperMetadata" }, { "$ref": "#/components/schemas/PrusaMetadata" }, { "$ref": "#/components/schemas/SdcpMetadata" }, { "$ref": "#/components/schemas/OctoPrintMetadata" } ] }, "integrationId": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "integrationType": { "oneOf": [ { "type": "null" }, { "const": "bambulab" }, { "const": "etsy" }, { "const": "shopify" }, { "const": "ebay" }, { "const": "tiktok-shop" }, { "const": "filametrics" } ] }, "tags": { "type": "array", "items": { "type": "string" } }, "deviceId": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "nozzleDiameter": { "type": "string" }, "enabled": { "type": "boolean" }, "commMethod": { "oneOf": [ { "type": "null" }, { "const": "bambu-global-mqtt" }, { "const": "bambu-cloud-v2" }, { "const": "octoprint-mqtt" }, { "const": "fuse" } ] }, "vendorModelId": { "oneOf": [ { "type": "null" }, { "type": "number" } ] }, "printerCapabilityPatch": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/JsonMergePatchPrinterCommCapabilities" } ], "title": "Per-printer capability override applied last (web Advanced Capabilities panel)", "description": "Per-printer capability override applied last (web Advanced Capabilities panel)." }, "printerAdapterBindingsPatch": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/JsonMergePatchPrinterAdapterBindings" } ], "title": "Per-printer adapter binding override applied last", "description": "Per-printer adapter binding override applied last." }, "id": { "type": "string" } }, "required": [ "id" ] }, "RenamePrinterOptions": { "type": "object", "properties": { "name": { "type": "string" } }, "required": [ "name" ] }, "BulkActionRequest": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "pattern": "^[a-z0-9]{24}$" } } }, "required": [ "ids" ] }, "LinkedPart": { "type": "object", "properties": { "skuId": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "partId": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "parameters": { "type": "array", "items": { "$ref": "#/components/schemas/PartParameterOverride" } }, "quantity": { "type": "number", "minimum": 0, "maximum": 500 }, "label": { "type": "string", "minLength": 1, "maxLength": 1024 }, "exposedParameters": { "type": "array", "items": { "type": "string" } }, "materialAssignments": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/RecordnumberArrayLinkedPartMaterialSpecification" } ] }, "extensions": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/LinkedPartExtensions" } ] }, "parameterBindings": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/Recordstringstring" } ] }, "plateQuantitiesBinding": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "id": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "storeId": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "skuId", "partId", "parameters", "quantity", "label", "exposedParameters", "id", "storeId", "createdAt", "updatedAt" ] }, "PartParameterOverride": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "type": { "oneOf": [ { "const": "number" }, { "const": "string" }, { "const": "boolean" } ] }, "value": { "oneOf": [ { "type": "number" }, { "type": "string", "minLength": 0, "maxLength": 255 }, { "type": "boolean" } ] } }, "required": [ "name", "type" ] }, "RecordnumberArrayLinkedPartMaterialSpecification": { "type": "object", "properties": {}, "description": "Construct a type with a set of properties K of type T", "additionalProperties": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "groupId": { "type": "string", "pattern": "^[a-z0-9]{24}$" } }, "required": [ "groupId" ] }, { "type": "object", "properties": { "variantId": { "type": "string", "pattern": "^[a-z0-9]{24}$" } }, "required": [ "variantId" ] }, { "type": "object", "properties": { "materialId": { "type": "string", "pattern": "^[a-z0-9]{24}$" } }, "required": [ "materialId" ] }, { "type": "object", "properties": { "materialType": { "type": "string" } }, "required": [ "materialType" ] }, { "type": "object", "properties": { "propertyId": { "type": "string" } }, "required": [ "propertyId" ] } ] } } }, "LinkedPartExtensions": { "type": "object", "properties": { "3mf": { "$ref": "#/components/schemas/PartExtension3MF" } } }, "PartExtension3MF": { "type": "object", "properties": { "plateQuantities": { "$ref": "#/components/schemas/PartExtension3MFPlateQuantities" }, "plateLabels": { "$ref": "#/components/schemas/PartExtension3MFPlateLabels" } }, "required": [ "plateQuantities" ] }, "PartExtension3MFPlateQuantities": { "type": "object", "properties": {}, "additionalProperties": { "type": "number" } }, "PartExtension3MFPlateLabels": { "type": "object", "properties": {}, "additionalProperties": { "type": "string" } }, "skuIdstringundefinedpartIdstringundefinedparametersstringundefinedquantitystringundefinedlabelstringundefinedexposedParametersstringundefined...7more...updatedAtstringundefinedQuerySettings...": { "type": "object", "properties": { "skuId": { "type": "string" }, "partId": { "type": "string" }, "parameters": { "type": "string" }, "quantity": { "type": "string" }, "label": { "type": "string" }, "exposedParameters": { "type": "string" }, "materialAssignments": { "type": "string" }, "extensions": { "type": "string" }, "parameterBindings": { "type": "string" }, "plateQuantitiesBinding": { "type": "string" }, "id": { "type": "string" }, "storeId": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "sort": { "type": "string", "title": "Sort", "description": "Sort specification in format \"field:asc,field2:desc\"" }, "limit": { "type": "number", "minimum": 1, "maximum": 1000, "title": "Limit", "description": "Maximum number of results to return (default: 100, max: 1000)" }, "offset": { "type": "number", "minimum": 0, "title": "Offset", "description": "Number of results to skip for pagination" }, "fields": { "type": "string", "title": "Fields", "description": "Comma-separated list of fields to return" }, "include": { "type": "string", "title": "Include", "description": "Comma-separated list of relations to include (max 4, max 2 levels deep).\nExample: \"linkedParts,linkedParts.part,folder\"" }, "meta": { "type": "boolean", "title": "Meta", "description": "If true, returns response with metadata (total, count, hasMore, etc.)" }, "hints": { "type": "boolean", "title": "Hints", "description": "If true, returns AI-friendly hints about available actions. Implies meta=true." } } }, "SearchQueryDtoLinkedPart": { "type": "object", "properties": { "filter": { "oneOf": [ { "$ref": "#/components/schemas/LogicalConditionLinkedPart" }, { "$ref": "#/components/schemas/FieldConditionLinkedPart" } ], "title": "Filter", "description": "Complex filter conditions using logical and field operators.\nAvailable field operators: eq, ne, gt, gte, lt, lte, contains, startsWith, endsWith, in, notIn, isNull, between.\nUsage example: {\"filter\": {\"and\": [{\"name\": {\"contains\": \"benchy\"}}, {\"or\": [{\"type\": {\"eq\": \"3mf\"}}, {\"type\": {\"eq\": \"gcode3mf\"}}]}}}" }, "sort": { "type": "string", "title": "Sort", "description": "Sort specification in format \"field:asc,field2:desc\"" }, "limit": { "type": "number", "minimum": 1, "maximum": 1000, "title": "Limit", "description": "Maximum number of results to return (default: 100, max: 1000)" }, "offset": { "type": "number", "minimum": 0, "title": "Offset", "description": "Number of results to skip for pagination" }, "fields": { "type": "string", "title": "Fields", "description": "Comma-separated list of fields to return" }, "include": { "type": "string", "title": "Include", "description": "Comma-separated list of relations to include (max 4, max 2 levels deep).\nExample: \"linkedParts,linkedParts.part,folder\"" }, "meta": { "type": "boolean", "title": "Meta", "description": "If true, returns response with metadata (total, count, hasMore, etc.)" }, "hints": { "type": "boolean", "title": "Hints", "description": "If true, returns AI-friendly hints about available actions. Implies meta=true." } }, "title": "Search Query", "description": "Complete search request with filter conditions and query settings" }, "LogicalConditionLinkedPart": { "type": "object", "properties": { "and": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/LogicalConditionLinkedPart" }, { "$ref": "#/components/schemas/FieldConditionLinkedPart" } ] }, "title": "AND Conditions", "description": "All conditions must be true" }, "or": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/LogicalConditionLinkedPart" }, { "$ref": "#/components/schemas/FieldConditionLinkedPart" } ] }, "title": "OR Conditions", "description": "At least one condition must be true" } }, "title": "Logical Condition", "description": "Logical operators for combining multiple filter conditions" }, "FieldConditionLinkedPart": { "type": "object", "properties": { "skuId": { "$ref": "#/components/schemas/FieldOperators" }, "partId": { "$ref": "#/components/schemas/FieldOperators" }, "parameters": { "$ref": "#/components/schemas/FieldOperators" }, "quantity": { "$ref": "#/components/schemas/FieldOperators" }, "label": { "$ref": "#/components/schemas/FieldOperators" }, "exposedParameters": { "$ref": "#/components/schemas/FieldOperators" }, "materialAssignments": { "$ref": "#/components/schemas/FieldOperators" }, "extensions": { "$ref": "#/components/schemas/FieldOperators" }, "parameterBindings": { "$ref": "#/components/schemas/FieldOperators" }, "plateQuantitiesBinding": { "$ref": "#/components/schemas/FieldOperators" }, "id": { "$ref": "#/components/schemas/FieldOperators" }, "storeId": { "$ref": "#/components/schemas/FieldOperators" }, "createdAt": { "$ref": "#/components/schemas/FieldOperators" }, "updatedAt": { "$ref": "#/components/schemas/FieldOperators" } }, "title": "Field Condition", "description": "Field-based filter conditions where keys are field names and values are field operators" }, "LinkedPartInsert": { "type": "object", "properties": { "skuId": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "parameters": { "type": "array", "items": { "$ref": "#/components/schemas/PartParameterOverride" } }, "partId": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "quantity": { "type": "number", "minimum": 0, "maximum": 500 }, "label": { "type": "string", "minLength": 1, "maxLength": 1024 }, "extensions": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/LinkedPartExtensions" } ] }, "materialAssignments": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/RecordnumberArrayLinkedPartMaterialSpecification" } ] }, "exposedParameters": { "type": "array", "items": { "type": "string" } }, "parameterBindings": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/Recordstringstring" } ] }, "plateQuantitiesBinding": { "oneOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": [ "parameters", "partId", "quantity", "label", "exposedParameters" ] }, "PartialLinkedPartInsert": { "type": "object", "properties": { "skuId": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "parameters": { "type": "array", "items": { "$ref": "#/components/schemas/PartParameterOverride" } }, "partId": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "quantity": { "type": "number", "minimum": 0, "maximum": 500 }, "label": { "type": "string", "minLength": 1, "maxLength": 1024 }, "extensions": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/LinkedPartExtensions" } ] }, "materialAssignments": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/RecordnumberArrayLinkedPartMaterialSpecification" } ] }, "exposedParameters": { "type": "array", "items": { "type": "string" } }, "parameterBindings": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/Recordstringstring" } ] }, "plateQuantitiesBinding": { "oneOf": [ { "type": "null" }, { "type": "string" } ] } }, "description": "Make all properties in T optional" }, "Profile": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 1024 }, "type": { "oneOf": [ { "const": "process" }, { "const": "filament" }, { "const": "machine" } ] }, "externalId": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "source": { "oneOf": [ { "const": "manual" }, { "const": "bambu-account" } ] }, "inherits": { "type": "string" }, "compatibilityList": { "type": "string" }, "data": { "$ref": "#/components/schemas/Recordstringany" }, "metadata": { "$ref": "#/components/schemas/Recordstringany" }, "integrationId": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "integrationType": { "oneOf": [ { "type": "null" }, { "const": "bambulab" }, { "const": "etsy" }, { "const": "shopify" }, { "const": "ebay" }, { "const": "tiktok-shop" }, { "const": "filametrics" } ] }, "storeId": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "updatedAt": { "type": "string", "format": "date-time" }, "createdAt": { "type": "string", "format": "date-time" } }, "required": [ "id", "name", "type", "externalId", "source", "inherits", "compatibilityList", "data", "metadata", "integrationId", "integrationType", "storeId", "updatedAt", "createdAt" ] }, "idstringundefinednamestringundefinedtypestringundefinedexternalIdstringundefinedsourcestringundefinedinheritsstringundefinedcompatibilityListstringundefined...6more...createdAtstringundefinedQuerySettings...": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string" }, "externalId": { "type": "string" }, "source": { "type": "string" }, "inherits": { "type": "string" }, "compatibilityList": { "type": "string" }, "data": { "type": "string" }, "metadata": { "type": "string" }, "integrationId": { "type": "string" }, "integrationType": { "type": "string" }, "storeId": { "type": "string" }, "updatedAt": { "type": "string" }, "createdAt": { "type": "string" }, "sort": { "type": "string", "title": "Sort", "description": "Sort specification in format \"field:asc,field2:desc\"" }, "limit": { "type": "number", "minimum": 1, "maximum": 1000, "title": "Limit", "description": "Maximum number of results to return (default: 100, max: 1000)" }, "offset": { "type": "number", "minimum": 0, "title": "Offset", "description": "Number of results to skip for pagination" }, "fields": { "type": "string", "title": "Fields", "description": "Comma-separated list of fields to return" }, "include": { "type": "string", "title": "Include", "description": "Comma-separated list of relations to include (max 4, max 2 levels deep).\nExample: \"linkedParts,linkedParts.part,folder\"" }, "meta": { "type": "boolean", "title": "Meta", "description": "If true, returns response with metadata (total, count, hasMore, etc.)" }, "hints": { "type": "boolean", "title": "Hints", "description": "If true, returns AI-friendly hints about available actions. Implies meta=true." } } }, "SearchQueryDtoProfile": { "type": "object", "properties": { "filter": { "oneOf": [ { "$ref": "#/components/schemas/LogicalConditionProfile" }, { "$ref": "#/components/schemas/FieldConditionProfile" } ], "title": "Filter", "description": "Complex filter conditions using logical and field operators.\nAvailable field operators: eq, ne, gt, gte, lt, lte, contains, startsWith, endsWith, in, notIn, isNull, between.\nUsage example: {\"filter\": {\"and\": [{\"name\": {\"contains\": \"benchy\"}}, {\"or\": [{\"type\": {\"eq\": \"3mf\"}}, {\"type\": {\"eq\": \"gcode3mf\"}}]}}}" }, "sort": { "type": "string", "title": "Sort", "description": "Sort specification in format \"field:asc,field2:desc\"" }, "limit": { "type": "number", "minimum": 1, "maximum": 1000, "title": "Limit", "description": "Maximum number of results to return (default: 100, max: 1000)" }, "offset": { "type": "number", "minimum": 0, "title": "Offset", "description": "Number of results to skip for pagination" }, "fields": { "type": "string", "title": "Fields", "description": "Comma-separated list of fields to return" }, "include": { "type": "string", "title": "Include", "description": "Comma-separated list of relations to include (max 4, max 2 levels deep).\nExample: \"linkedParts,linkedParts.part,folder\"" }, "meta": { "type": "boolean", "title": "Meta", "description": "If true, returns response with metadata (total, count, hasMore, etc.)" }, "hints": { "type": "boolean", "title": "Hints", "description": "If true, returns AI-friendly hints about available actions. Implies meta=true." } }, "title": "Search Query", "description": "Complete search request with filter conditions and query settings" }, "LogicalConditionProfile": { "type": "object", "properties": { "and": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/LogicalConditionProfile" }, { "$ref": "#/components/schemas/FieldConditionProfile" } ] }, "title": "AND Conditions", "description": "All conditions must be true" }, "or": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/LogicalConditionProfile" }, { "$ref": "#/components/schemas/FieldConditionProfile" } ] }, "title": "OR Conditions", "description": "At least one condition must be true" } }, "title": "Logical Condition", "description": "Logical operators for combining multiple filter conditions" }, "FieldConditionProfile": { "type": "object", "properties": { "id": { "$ref": "#/components/schemas/FieldOperators" }, "name": { "$ref": "#/components/schemas/FieldOperators" }, "type": { "$ref": "#/components/schemas/FieldOperators" }, "externalId": { "$ref": "#/components/schemas/FieldOperators" }, "source": { "$ref": "#/components/schemas/FieldOperators" }, "inherits": { "$ref": "#/components/schemas/FieldOperators" }, "compatibilityList": { "$ref": "#/components/schemas/FieldOperators" }, "data": { "$ref": "#/components/schemas/FieldOperators" }, "metadata": { "$ref": "#/components/schemas/FieldOperators" }, "integrationId": { "$ref": "#/components/schemas/FieldOperators" }, "integrationType": { "$ref": "#/components/schemas/FieldOperators" }, "storeId": { "$ref": "#/components/schemas/FieldOperators" }, "updatedAt": { "$ref": "#/components/schemas/FieldOperators" }, "createdAt": { "$ref": "#/components/schemas/FieldOperators" } }, "title": "Field Condition", "description": "Field-based filter conditions where keys are field names and values are field operators" }, "SupportedPrinter": { "type": "object", "properties": { "name": { "type": "string" }, "nozzleDiameter": { "type": "array", "items": { "type": "string" } } }, "required": [ "name", "nozzleDiameter" ] }, "PrinterModel": { "type": "object", "properties": { "id": { "type": "number" }, "vendorId": { "type": "number" }, "name": { "type": "string" }, "nozzleDiameters": { "type": "array", "items": { "type": "string" } }, "modelId": { "oneOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": [ "id", "vendorId", "name", "nozzleDiameters", "modelId" ] }, "CompatibleProfiles": { "type": "object", "properties": { "machine": { "$ref": "#/components/schemas/CompatibleProfileList" }, "filament": { "$ref": "#/components/schemas/CompatibleProfileList" }, "process": { "$ref": "#/components/schemas/CompatibleProfileList" } }, "required": [ "machine", "filament", "process" ] }, "CompatibleProfileList": { "type": "object", "properties": { "system": { "type": "array", "items": { "$ref": "#/components/schemas/SlicerConfig" } }, "user": { "type": "array", "items": { "$ref": "#/components/schemas/Profile" } } }, "required": [ "system", "user" ] }, "SlicerConfig": { "type": "object", "properties": { "id": { "type": "number" }, "vendorId": { "type": "number" }, "name": { "type": "string" }, "type": { "oneOf": [ { "const": "process" }, { "const": "filament" }, { "const": "machine" } ] }, "shown": { "type": "boolean" }, "compatibilityList": { "type": "string" }, "data": { "$ref": "#/components/schemas/Recordstringany" }, "machineVariant": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "machineModel": { "oneOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": [ "id", "vendorId", "name", "type", "shown", "compatibilityList", "data", "machineVariant", "machineModel" ] }, "ProfileWithInheritance": { "type": "object", "properties": { "merged": { "$ref": "#/components/schemas/Recordstringany" }, "ownKeys": { "type": "array", "items": { "type": "string" } }, "inheritedKeys": { "type": "array", "items": { "type": "string" } }, "inheritsFrom": { "oneOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": [ "merged", "ownKeys", "inheritedKeys", "inheritsFrom" ] }, "ProfilePreviewResult": { "type": "object", "properties": { "bundleType": { "oneOf": [ { "const": "filament" }, { "const": "printer" }, { "const": "presets" } ] }, "profiles": { "type": "object", "properties": { "machine": { "type": "array", "items": { "$ref": "#/components/schemas/ProfilePreviewItem" } }, "filament": { "type": "array", "items": { "$ref": "#/components/schemas/ProfilePreviewItem" } }, "process": { "type": "array", "items": { "$ref": "#/components/schemas/ProfilePreviewItem" } } }, "required": [ "machine", "filament", "process" ] }, "totalCount": { "type": "number" } }, "required": [ "bundleType", "profiles", "totalCount" ] }, "ProfilePreviewItem": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "oneOf": [ { "const": "process" }, { "const": "filament" }, { "const": "machine" } ] }, "inherits": { "type": "string" }, "filamentType": { "type": "string" }, "filamentVendor": { "type": "string" }, "color": { "type": "string" }, "existsInStore": { "type": "boolean" } }, "required": [ "name", "type", "existsInStore" ] }, "ProfileUploadBody": { "type": "object", "properties": { "file": { "type": "string", "format": "binary" } }, "required": [ "file" ] }, "ProfileImportResult": { "type": "object", "properties": { "profiles": { "type": "object", "properties": { "created": { "type": "array", "items": { "type": "string" } }, "updated": { "type": "array", "items": { "type": "string" } }, "skipped": { "type": "array", "items": { "type": "string" } } }, "required": [ "created", "updated", "skipped" ] }, "materials": { "type": "object", "properties": { "created": { "type": "array", "items": { "type": "string" } } }, "required": [ "created" ] } }, "required": [ "profiles" ] }, "ProfileImportBody": { "type": "object", "properties": { "file": { "type": "string", "format": "binary" }, "createMaterials": { "type": "boolean" }, "overwriteExisting": { "type": "boolean" }, "selectedProfiles": { "type": "array", "items": { "type": "string" } } }, "required": [ "file" ] }, "ProfileImportDataBody": { "type": "object", "properties": { "profiles": { "type": "array", "items": { "$ref": "#/components/schemas/ParsedProfileData" } }, "createMaterials": { "type": "boolean" }, "overwriteExisting": { "type": "boolean" }, "materialIdentifiers": { "type": "array", "items": { "type": "string" }, "title": "Filament IDs (uppercase) of materials to create. If not provided, creates all", "description": "Filament IDs (uppercase) of materials to create. If not provided, creates all." }, "filamentProfilesForMaterials": { "type": "array", "items": { "$ref": "#/components/schemas/ParsedProfileData" }, "description": "Filament profiles to use for material creation (when not importing them as profiles)" } }, "required": [ "profiles", "createMaterials", "overwriteExisting" ], "description": "Request body for importing pre-parsed profile data.\nUsed when profiles are parsed client-side and sent directly to the server." }, "ParsedProfileData": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "oneOf": [ { "const": "process" }, { "const": "filament" }, { "const": "machine" } ] }, "data": { "$ref": "#/components/schemas/Recordstringany" }, "inherits": { "type": "string" }, "compatiblePrinters": { "type": "array", "items": { "type": "string" } }, "filamentType": { "type": "string" }, "filamentVendor": { "type": "string" }, "color": { "type": "string" } }, "required": [ "name", "type", "data" ] }, "ProfileInsert": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 1024 }, "type": { "oneOf": [ { "const": "process" }, { "const": "filament" }, { "const": "machine" } ] }, "externalId": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "data": { "$ref": "#/components/schemas/Recordstringany" }, "inherits": { "type": "string" }, "compatibilityList": { "type": "string" }, "source": { "oneOf": [ { "const": "manual" }, { "const": "bambu-account" } ] }, "metadata": { "$ref": "#/components/schemas/Recordstringany" }, "integrationId": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "integrationType": { "oneOf": [ { "type": "null" }, { "const": "bambulab" }, { "const": "etsy" }, { "const": "shopify" }, { "const": "ebay" }, { "const": "tiktok-shop" }, { "const": "filametrics" } ] } }, "required": [ "name", "type", "externalId", "data", "inherits", "compatibilityList", "source", "metadata", "integrationId", "integrationType" ] }, "ProfileUpdateDto": { "type": "object", "properties": { "name": { "type": "string" }, "data": { "$ref": "#/components/schemas/Recordstringany" }, "inherits": { "type": "string" } } }, "PrintJob": { "type": "object", "properties": { "partBuildId": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "quantityIndex": { "type": "number" }, "quantityTotal": { "type": "number" }, "thumbnailUri": { "oneOf": [ { "type": "null" }, { "type": "string", "minLength": 1 } ] }, "coloredThumbnailUri": { "oneOf": [ { "type": "null" }, { "type": "string", "minLength": 1 } ] }, "buildThumbnailUri": { "oneOf": [ { "type": "null" }, { "type": "string", "minLength": 1 } ] }, "cameraThumbnailUri": { "oneOf": [ { "type": "null" }, { "type": "string", "minLength": 1 } ], "description": "Camera-captured snapshot from the moment Fuse detected the last\nlayer of the print. Persisted to the files bucket. Null unless Fuse\nsuccessfully captured and uploaded." }, "timelapseUri": { "oneOf": [ { "type": "null" }, { "type": "string", "minLength": 1 } ], "description": "MP4 timelapse Fuse encoded from frames captured during the print and\nuploaded to the snapshots bucket under the `timelapses/` prefix.\nNull unless the store has timelapses enabled and Fuse uploaded\nsuccessfully." }, "filesToPrint": { "type": "array", "items": { "type": "string", "minLength": 1 } }, "slicerInputHash": { "oneOf": [ { "type": "null" }, { "type": "string", "minLength": 1 } ] }, "isGcodeCached": { "type": "boolean" }, "slicedGcodeUri": { "oneOf": [ { "type": "null" }, { "type": "string", "minLength": 1 } ] }, "partId": { "oneOf": [ { "type": "null" }, { "type": "string", "pattern": "^[a-z0-9]{24}$" } ] }, "partName": { "type": "string", "minLength": 1, "maxLength": 1024 }, "skuId": { "oneOf": [ { "type": "null" }, { "type": "string", "pattern": "^[a-z0-9]{24}$" } ] }, "skuName": { "oneOf": [ { "type": "null" }, { "type": "string", "minLength": 1 } ] }, "parameterOverrides": { "type": "array", "items": { "$ref": "#/components/schemas/PartParameterOverride" } }, "orderId": { "oneOf": [ { "type": "null" }, { "type": "string", "pattern": "^[a-z0-9]{24}$" } ] }, "label": { "type": "string" }, "orderItemId": { "oneOf": [ { "type": "null" }, { "type": "string", "pattern": "^[a-z0-9]{24}$" } ] }, "linkedPartId": { "oneOf": [ { "type": "null" }, { "type": "string", "pattern": "^[a-z0-9]{24}$" } ] }, "skuInstance": { "oneOf": [ { "type": "null" }, { "type": "number" } ] }, "queueOrder": { "type": "number", "minimum": 0 }, "priority": { "oneOf": [ { "const": 100 }, { "const": 1000 } ] }, "requiredPrinterTags": { "$ref": "#/components/schemas/Tags" }, "overriddenProcessProfileId": { "oneOf": [ { "type": "null" }, { "type": "string", "pattern": "^[a-z0-9]{24}$" } ] }, "taskId": { "type": "number" }, "profileUris": { "oneOf": [ { "type": "null" }, { "type": "array", "items": { "type": "string" } } ] }, "assignedPrinterId": { "oneOf": [ { "type": "null" }, { "type": "string", "pattern": "^[a-z0-9]{24}$" } ] }, "assignmentStartedAt": { "oneOf": [ { "type": "null" }, { "type": "string", "format": "date-time" } ] }, "assignmentCompletedAt": { "oneOf": [ { "type": "null" }, { "type": "string", "format": "date-time" } ] }, "printingStartedAt": { "oneOf": [ { "type": "null" }, { "type": "string", "format": "date-time" } ] }, "printingCompletedAt": { "oneOf": [ { "type": "null" }, { "type": "string", "format": "date-time" } ] }, "cancelledAt": { "oneOf": [ { "type": "null" }, { "type": "string", "format": "date-time" } ] }, "status": { "oneOf": [ { "const": "pending" }, { "const": "assigned" }, { "const": "slicing" }, { "const": "sliced" }, { "const": "finalizing" }, { "const": "waiting-for-approval" }, { "const": "ready-for-printer" }, { "const": "sending-to-printer" }, { "const": "printing" }, { "const": "paused" }, { "const": "completed" }, { "const": "failed" }, { "const": "cancelled" } ] }, "errorMessage": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "hidden": { "type": "boolean" }, "logsUri": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "extensions": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/PrintJobExtensions" } ] }, "skipObjectsData": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/SkipObjectsData" } ] }, "skipObjectIds": { "oneOf": [ { "type": "null" }, { "type": "array", "items": { "type": "string" } } ], "description": "User-selected objects to skip on this job's plate, as identifyId strings\n(resolved at queue time from the part's plate object list). When the print\nstarts, a Bambu `skip_objects` command is auto-sent for these. Null/empty\nmeans print everything. Stored as strings; converted to integer obj_list at\nsend time." }, "materialMapping": { "oneOf": [ { "type": "null" }, { "type": "array", "items": { "$ref": "#/components/schemas/PrintJobMaterialMapping" } } ] }, "materialAssignments": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/RecordnumberArraySingleMaterialSpecification" } ] }, "gcodeAnalysisSha256": { "oneOf": [ { "type": "null" }, { "type": "string" } ], "description": "SHA256 hash of analyzed gcode content — stable key for extrusion lookup" }, "groupId": { "oneOf": [ { "type": "null" }, { "type": "string", "pattern": "^[a-z0-9]{24}$" } ], "description": "Group identifier for visually-collapsed print-queue rows. Assigned at\nemission (one per plate cluster within a build). Split mints fresh\ngroupIds for non-first buckets. May be null for legacy rows that predate\nthe grouping feature." }, "id": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "storeId": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "partBuildId", "quantityIndex", "quantityTotal", "thumbnailUri", "coloredThumbnailUri", "buildThumbnailUri", "cameraThumbnailUri", "timelapseUri", "filesToPrint", "slicerInputHash", "isGcodeCached", "slicedGcodeUri", "partId", "partName", "skuId", "skuName", "parameterOverrides", "orderId", "label", "orderItemId", "linkedPartId", "skuInstance", "queueOrder", "priority", "requiredPrinterTags", "overriddenProcessProfileId", "taskId", "profileUris", "assignedPrinterId", "assignmentStartedAt", "assignmentCompletedAt", "printingStartedAt", "printingCompletedAt", "cancelledAt", "status", "errorMessage", "hidden", "logsUri", "materialMapping", "materialAssignments", "gcodeAnalysisSha256", "groupId", "id", "storeId", "createdAt", "updatedAt" ] }, "PrintJobExtensions": { "type": "object", "properties": { "3mf": { "$ref": "#/components/schemas/PrintJobExtension3MF" } } }, "PrintJobExtension3MF": { "type": "object", "properties": { "plateId": { "type": "number" }, "gcodeFile": { "type": "string" } }, "required": [ "plateId", "gcodeFile" ] }, "SkipObjectsData": { "type": "object", "properties": { "objects": { "type": "array", "items": { "type": "object", "properties": { "identifyId": { "type": "string" }, "name": { "type": "string" }, "skipped": { "type": "boolean" } }, "required": [ "identifyId", "name", "skipped" ] } }, "topImageUri": { "type": "string" }, "pickImageUri": { "type": "string" } }, "required": [ "objects" ] }, "PrintJobMaterialMapping": { "type": "object", "properties": { "slot": { "type": "number", "deprecated": true }, "amsIndex": { "type": "number", "description": "Visual AMS array index: -1 for spool, 0+ for AMS units" }, "slotIndex": { "type": "number", "description": "Slot within the AMS, or spool index for multiple spools" }, "skip": { "type": "boolean" }, "variantId": { "type": "string" }, "materialId": { "type": "string" }, "materialType": { "type": "string" }, "name": { "type": "string" }, "color": { "type": "string" }, "filamentUserProfileId": { "oneOf": [ { "type": "null" }, { "type": "string", "pattern": "^[a-z0-9]{24}$" } ] }, "filamentSystemProfileId": { "oneOf": [ { "type": "null" }, { "type": "number" } ] } } }, "RecordnumberArraySingleMaterialSpecification": { "type": "object", "properties": {}, "description": "Construct a type with a set of properties K of type T", "additionalProperties": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "groupId": { "type": "string", "pattern": "^[a-z0-9]{24}$" } }, "required": [ "groupId" ] }, { "type": "object", "properties": { "variantId": { "type": "string", "pattern": "^[a-z0-9]{24}$" } }, "required": [ "variantId" ] }, { "type": "object", "properties": { "materialId": { "type": "string", "pattern": "^[a-z0-9]{24}$" } }, "required": [ "materialId" ] }, { "type": "object", "properties": { "materialType": { "type": "string" } }, "required": [ "materialType" ] } ] } } }, "partBuildIdstringundefinedquantityIndexstringundefinedquantityTotalstringundefinedthumbnailUristringundefinedcoloredThumbnailUristringundefined...43more...updatedAtstringundefinedQuerySettings...": { "type": "object", "properties": { "partBuildId": { "type": "string" }, "quantityIndex": { "type": "string" }, "quantityTotal": { "type": "string" }, "thumbnailUri": { "type": "string" }, "coloredThumbnailUri": { "type": "string" }, "buildThumbnailUri": { "type": "string" }, "cameraThumbnailUri": { "type": "string", "description": "Camera-captured snapshot from the moment Fuse detected the last\nlayer of the print. Persisted to the files bucket. Null unless Fuse\nsuccessfully captured and uploaded." }, "timelapseUri": { "type": "string", "description": "MP4 timelapse Fuse encoded from frames captured during the print and\nuploaded to the snapshots bucket under the `timelapses/` prefix.\nNull unless the store has timelapses enabled and Fuse uploaded\nsuccessfully." }, "filesToPrint": { "type": "string" }, "slicerInputHash": { "type": "string" }, "isGcodeCached": { "type": "string" }, "slicedGcodeUri": { "type": "string" }, "partId": { "type": "string" }, "partName": { "type": "string" }, "skuId": { "type": "string" }, "skuName": { "type": "string" }, "parameterOverrides": { "type": "string" }, "orderId": { "type": "string" }, "label": { "type": "string" }, "orderItemId": { "type": "string" }, "linkedPartId": { "type": "string" }, "skuInstance": { "type": "string" }, "queueOrder": { "type": "string" }, "priority": { "type": "string" }, "requiredPrinterTags": { "type": "string" }, "overriddenProcessProfileId": { "type": "string" }, "taskId": { "type": "string" }, "profileUris": { "type": "string" }, "assignedPrinterId": { "type": "string" }, "assignmentStartedAt": { "type": "string" }, "assignmentCompletedAt": { "type": "string" }, "printingStartedAt": { "type": "string" }, "printingCompletedAt": { "type": "string" }, "cancelledAt": { "type": "string" }, "status": { "type": "string" }, "errorMessage": { "type": "string" }, "hidden": { "type": "string" }, "logsUri": { "type": "string" }, "extensions": { "type": "string" }, "skipObjectsData": { "type": "string" }, "skipObjectIds": { "type": "string", "description": "User-selected objects to skip on this job's plate, as identifyId strings\n(resolved at queue time from the part's plate object list). When the print\nstarts, a Bambu `skip_objects` command is auto-sent for these. Null/empty\nmeans print everything. Stored as strings; converted to integer obj_list at\nsend time." }, "materialMapping": { "type": "string" }, "materialAssignments": { "type": "string" }, "gcodeAnalysisSha256": { "type": "string", "description": "SHA256 hash of analyzed gcode content — stable key for extrusion lookup" }, "groupId": { "type": "string", "description": "Group identifier for visually-collapsed print-queue rows. Assigned at\nemission (one per plate cluster within a build). Split mints fresh\ngroupIds for non-first buckets. May be null for legacy rows that predate\nthe grouping feature." }, "id": { "type": "string" }, "storeId": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "sort": { "type": "string", "title": "Sort", "description": "Sort specification in format \"field:asc,field2:desc\"" }, "limit": { "type": "number", "minimum": 1, "maximum": 1000, "title": "Limit", "description": "Maximum number of results to return (default: 100, max: 1000)" }, "offset": { "type": "number", "minimum": 0, "title": "Offset", "description": "Number of results to skip for pagination" }, "fields": { "type": "string", "title": "Fields", "description": "Comma-separated list of fields to return" }, "include": { "type": "string", "title": "Include", "description": "Comma-separated list of relations to include (max 4, max 2 levels deep).\nExample: \"linkedParts,linkedParts.part,folder\"" }, "meta": { "type": "boolean", "title": "Meta", "description": "If true, returns response with metadata (total, count, hasMore, etc.)" }, "hints": { "type": "boolean", "title": "Hints", "description": "If true, returns AI-friendly hints about available actions. Implies meta=true." } } }, "SearchQueryDtoPrintJob": { "type": "object", "properties": { "filter": { "oneOf": [ { "$ref": "#/components/schemas/LogicalConditionPrintJob" }, { "$ref": "#/components/schemas/FieldConditionPrintJob" } ], "title": "Filter", "description": "Complex filter conditions using logical and field operators.\nAvailable field operators: eq, ne, gt, gte, lt, lte, contains, startsWith, endsWith, in, notIn, isNull, between.\nUsage example: {\"filter\": {\"and\": [{\"name\": {\"contains\": \"benchy\"}}, {\"or\": [{\"type\": {\"eq\": \"3mf\"}}, {\"type\": {\"eq\": \"gcode3mf\"}}]}}}" }, "sort": { "type": "string", "title": "Sort", "description": "Sort specification in format \"field:asc,field2:desc\"" }, "limit": { "type": "number", "minimum": 1, "maximum": 1000, "title": "Limit", "description": "Maximum number of results to return (default: 100, max: 1000)" }, "offset": { "type": "number", "minimum": 0, "title": "Offset", "description": "Number of results to skip for pagination" }, "fields": { "type": "string", "title": "Fields", "description": "Comma-separated list of fields to return" }, "include": { "type": "string", "title": "Include", "description": "Comma-separated list of relations to include (max 4, max 2 levels deep).\nExample: \"linkedParts,linkedParts.part,folder\"" }, "meta": { "type": "boolean", "title": "Meta", "description": "If true, returns response with metadata (total, count, hasMore, etc.)" }, "hints": { "type": "boolean", "title": "Hints", "description": "If true, returns AI-friendly hints about available actions. Implies meta=true." } }, "title": "Search Query", "description": "Complete search request with filter conditions and query settings" }, "LogicalConditionPrintJob": { "type": "object", "properties": { "and": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/LogicalConditionPrintJob" }, { "$ref": "#/components/schemas/FieldConditionPrintJob" } ] }, "title": "AND Conditions", "description": "All conditions must be true" }, "or": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/LogicalConditionPrintJob" }, { "$ref": "#/components/schemas/FieldConditionPrintJob" } ] }, "title": "OR Conditions", "description": "At least one condition must be true" } }, "title": "Logical Condition", "description": "Logical operators for combining multiple filter conditions" }, "FieldConditionPrintJob": { "type": "object", "properties": { "partBuildId": { "$ref": "#/components/schemas/FieldOperators" }, "quantityIndex": { "$ref": "#/components/schemas/FieldOperators" }, "quantityTotal": { "$ref": "#/components/schemas/FieldOperators" }, "thumbnailUri": { "$ref": "#/components/schemas/FieldOperators" }, "coloredThumbnailUri": { "$ref": "#/components/schemas/FieldOperators" }, "buildThumbnailUri": { "$ref": "#/components/schemas/FieldOperators" }, "cameraThumbnailUri": { "$ref": "#/components/schemas/FieldOperators", "description": "Camera-captured snapshot from the moment Fuse detected the last\nlayer of the print. Persisted to the files bucket. Null unless Fuse\nsuccessfully captured and uploaded." }, "timelapseUri": { "$ref": "#/components/schemas/FieldOperators", "description": "MP4 timelapse Fuse encoded from frames captured during the print and\nuploaded to the snapshots bucket under the `timelapses/` prefix.\nNull unless the store has timelapses enabled and Fuse uploaded\nsuccessfully." }, "filesToPrint": { "$ref": "#/components/schemas/FieldOperators" }, "slicerInputHash": { "$ref": "#/components/schemas/FieldOperators" }, "isGcodeCached": { "$ref": "#/components/schemas/FieldOperators" }, "slicedGcodeUri": { "$ref": "#/components/schemas/FieldOperators" }, "partId": { "$ref": "#/components/schemas/FieldOperators" }, "partName": { "$ref": "#/components/schemas/FieldOperators" }, "skuId": { "$ref": "#/components/schemas/FieldOperators" }, "skuName": { "$ref": "#/components/schemas/FieldOperators" }, "parameterOverrides": { "$ref": "#/components/schemas/FieldOperators" }, "orderId": { "$ref": "#/components/schemas/FieldOperators" }, "label": { "$ref": "#/components/schemas/FieldOperators" }, "orderItemId": { "$ref": "#/components/schemas/FieldOperators" }, "linkedPartId": { "$ref": "#/components/schemas/FieldOperators" }, "skuInstance": { "$ref": "#/components/schemas/FieldOperators" }, "queueOrder": { "$ref": "#/components/schemas/FieldOperators" }, "priority": { "$ref": "#/components/schemas/FieldOperators" }, "requiredPrinterTags": { "$ref": "#/components/schemas/FieldOperators" }, "overriddenProcessProfileId": { "$ref": "#/components/schemas/FieldOperators" }, "taskId": { "$ref": "#/components/schemas/FieldOperators" }, "profileUris": { "$ref": "#/components/schemas/FieldOperators" }, "assignedPrinterId": { "$ref": "#/components/schemas/FieldOperators" }, "assignmentStartedAt": { "$ref": "#/components/schemas/FieldOperators" }, "assignmentCompletedAt": { "$ref": "#/components/schemas/FieldOperators" }, "printingStartedAt": { "$ref": "#/components/schemas/FieldOperators" }, "printingCompletedAt": { "$ref": "#/components/schemas/FieldOperators" }, "cancelledAt": { "$ref": "#/components/schemas/FieldOperators" }, "status": { "$ref": "#/components/schemas/FieldOperators" }, "errorMessage": { "$ref": "#/components/schemas/FieldOperators" }, "hidden": { "$ref": "#/components/schemas/FieldOperators" }, "logsUri": { "$ref": "#/components/schemas/FieldOperators" }, "extensions": { "$ref": "#/components/schemas/FieldOperators" }, "skipObjectsData": { "$ref": "#/components/schemas/FieldOperators" }, "skipObjectIds": { "$ref": "#/components/schemas/FieldOperators", "description": "User-selected objects to skip on this job's plate, as identifyId strings\n(resolved at queue time from the part's plate object list). When the print\nstarts, a Bambu `skip_objects` command is auto-sent for these. Null/empty\nmeans print everything. Stored as strings; converted to integer obj_list at\nsend time." }, "materialMapping": { "$ref": "#/components/schemas/FieldOperators" }, "materialAssignments": { "$ref": "#/components/schemas/FieldOperators" }, "gcodeAnalysisSha256": { "$ref": "#/components/schemas/FieldOperators", "description": "SHA256 hash of analyzed gcode content — stable key for extrusion lookup" }, "groupId": { "$ref": "#/components/schemas/FieldOperators", "description": "Group identifier for visually-collapsed print-queue rows. Assigned at\nemission (one per plate cluster within a build). Split mints fresh\ngroupIds for non-first buckets. May be null for legacy rows that predate\nthe grouping feature." }, "id": { "$ref": "#/components/schemas/FieldOperators" }, "storeId": { "$ref": "#/components/schemas/FieldOperators" }, "createdAt": { "$ref": "#/components/schemas/FieldOperators" }, "updatedAt": { "$ref": "#/components/schemas/FieldOperators" } }, "title": "Field Condition", "description": "Field-based filter conditions where keys are field names and values are field operators" }, "PrintJobOperationRequest": { "type": "object", "properties": { "printJobIds": { "type": "array", "items": { "type": "string" } } }, "required": [ "printJobIds" ] }, "CancelPrintJobsRequest": { "type": "object", "properties": { "sendStop": { "type": "boolean", "description": "Whether to also send a STOP command to the printer(s) any of these jobs\nare currently on. Defaults to true. Surfaced as the \"Send stop command\nto the printer(s)\" checkbox on the cancel confirmation. The stop is\ndispatched directly to the assigned printer with no taskId/online gate —\nthe operator explicitly asked to stop, so we don't second-guess it from\n(possibly stale) printer state. Set false to only mark the jobs cancelled\nin Printago without touching the hardware." }, "printJobIds": { "type": "array", "items": { "type": "string" } } }, "required": [ "printJobIds" ] }, "ArchivedPrintJobsResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/PrintJob" } }, "nextCursor": { "oneOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": [ "items", "nextCursor" ] }, "AdjustGroupQuantityResponse": { "type": "object", "properties": { "group": { "$ref": "#/components/schemas/PrintJobGroup" } }, "required": [ "group" ] }, "PrintJobGroup": { "type": "object", "properties": { "groupId": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "jobs": { "type": "array", "items": { "$ref": "#/components/schemas/PrintJob" } } }, "required": [ "groupId", "jobs" ] }, "AdjustGroupQuantityRequest": { "type": "object", "properties": { "groupKey": { "$ref": "#/components/schemas/PrintJobGroupKey" }, "targetQuantity": { "type": "number", "minimum": 1, "maximum": 500, "title": "Desired total quantity for the group. 1..500 inclusive", "description": "Desired total quantity for the group. 1..500 inclusive." } }, "required": [ "groupKey", "targetQuantity" ] }, "PrintJobGroupKey": { "type": "object", "properties": { "groupId": { "type": "string", "pattern": "^[a-z0-9]{24}$" } }, "required": [ "groupId" ], "description": "Identifies a print-queue group. `groupId` is assigned at emission time by\n`queuePrintJobs` (one groupId per distinct plate cluster within a build),\nso every emitted job has a non-null groupId. Pre-feature legacy rows with\nnull groupId are not addressable by this API." }, "SplitGroupResponse": { "type": "object", "properties": { "groups": { "type": "array", "items": { "$ref": "#/components/schemas/PrintJobGroup" } }, "affectedJobs": { "type": "array", "items": { "$ref": "#/components/schemas/PrintJob" }, "description": "Every lane row whose queueOrder changed as a side effect of the split's\nfull lane rebalance — includes the split buckets themselves plus any\nother pending groups in the same priority lane that got renumbered.\nThe client should setMany these into its local cache so the post-split\norder appears immediately instead of waiting for realtime sync." } }, "required": [ "groups", "affectedJobs" ] }, "SplitGroupRequest": { "type": "object", "properties": { "groupKey": { "$ref": "#/components/schemas/PrintJobGroupKey" }, "buckets": { "type": "array", "items": { "type": "number", "minimum": 1 }, "description": "Sizes of the resulting buckets in queue order. Must contain at least two\nentries and sum to the current group size. Bucket 0 retains the original\ngroupId (null or existing); buckets 1..N-1 get fresh CUID2s." } }, "required": [ "groupKey", "buckets" ] }, "ReorderGroupResponse": { "type": "object", "properties": { "affectedJobs": { "type": "array", "items": { "$ref": "#/components/schemas/PrintJob" }, "title": "Every PrintJob whose queueOrder changed as a result of the rebalance", "description": "Every PrintJob whose queueOrder changed as a result of the rebalance.\nClients should upsert these into their local cache to reflect the\nauthoritative post-state without re-fetching the full queue." } }, "required": [ "affectedJobs" ] }, "ReorderGroupRequest": { "type": "object", "properties": { "groupKey": { "$ref": "#/components/schemas/PrintJobGroupKey" }, "afterGroupId": { "oneOf": [ { "type": "null" }, { "type": "string", "pattern": "^[a-z0-9]{24}$" } ], "description": "Place the target group immediately after this group in the priority\nlane, or at the top when null. The server rebalances the lane so every\ngroup ends up at a clean 1000-spaced queueOrder — this avoids the\n\"same-queueOrder collision\" pitfall where midpoint-averaging between\ntwo groups at the same qo produces that qo and collapses the insert." } }, "required": [ "groupKey", "afterGroupId" ] }, "PrintJobMatchingDetail": { "type": "object", "properties": { "printJobId": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "details": { "$ref": "#/components/schemas/RecordstringMatchingDetails" }, "id": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "storeId": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "printJobId", "details", "id", "storeId", "createdAt", "updatedAt" ] }, "RecordstringMatchingDetails": { "type": "object", "properties": {}, "description": "Construct a type with a set of properties K of type T", "additionalProperties": { "$ref": "#/components/schemas/MatchingDetails" } }, "MatchingDetails": { "type": "object", "properties": { "priority": { "type": "number" }, "matched": { "type": "boolean" }, "data": { "oneOf": [ { "$ref": "#/components/schemas/DetailPreviousMismatch" }, { "$ref": "#/components/schemas/DetailDataTagMismatch" }, { "$ref": "#/components/schemas/DetailDataNoSlots" }, { "$ref": "#/components/schemas/DetailMissingProfile" }, { "$ref": "#/components/schemas/DetailDataMaterialMismatch" }, { "$ref": "#/components/schemas/DetailDataMatched" } ] }, "reason": { "type": "string" }, "reasonCode": { "oneOf": [ { "const": "missing-profile" }, { "const": "tag-mismatch" }, { "const": "previous-mismatch" }, { "const": "no-slots" }, { "const": "material-mismatch" }, { "const": "matched" } ] } }, "required": [ "matched", "data", "reason", "reasonCode" ] }, "DetailPreviousMismatch": { "type": "object", "properties": { "partId": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "plateId": { "type": "number" } }, "required": [ "partId" ] }, "DetailDataTagMismatch": { "type": "object", "properties": { "required": { "$ref": "#/components/schemas/Tags" }, "printer": { "$ref": "#/components/schemas/Recordstringany" } }, "required": [ "required", "printer" ] }, "DetailDataNoSlots": { "type": "object", "properties": { "config": { "$ref": "#/components/schemas/Recordstringany" }, "slots": { "type": "array", "items": { "$ref": "#/components/schemas/PrinterSlot" } } }, "required": [ "config", "slots" ] }, "PrinterSlot": { "type": "object", "properties": { "printerId": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "materialId": { "oneOf": [ { "type": "null" }, { "type": "string", "pattern": "^[a-z0-9]{24}$" } ] }, "variantId": { "oneOf": [ { "type": "null" }, { "type": "string", "pattern": "^[a-z0-9]{24}$" } ] }, "instanceId": { "oneOf": [ { "type": "null" }, { "type": "string", "pattern": "^[a-z0-9]{24}$" } ] }, "materialType": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "expectedData": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/BambuExpectedData" } ] }, "expectedDataSetAt": { "oneOf": [ { "type": "null" }, { "type": "string", "format": "date-time" } ] }, "amsIndex": { "type": "number", "description": "Visual slot position: -1 for spool, 0+ for AMS array index" }, "slotIndex": { "type": "number", "description": "Slot within AMS, or spool index for multiple spools" }, "slot": { "type": "number", "minimum": -64, "maximum": 255, "deprecated": true }, "filamentUserProfileId": { "oneOf": [ { "type": "null" }, { "type": "string", "pattern": "^[a-z0-9]{24}$" } ] }, "filamentSystemProfileId": { "oneOf": [ { "type": "null" }, { "type": "number" } ] }, "id": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "storeId": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "printerId", "materialId", "variantId", "instanceId", "materialType", "expectedData", "expectedDataSetAt", "amsIndex", "slotIndex", "filamentUserProfileId", "filamentSystemProfileId", "id", "storeId", "createdAt", "updatedAt" ] }, "BambuExpectedData": { "type": "object", "properties": { "color": { "type": "string" }, "identifier": { "type": "string" }, "type": { "type": "string" } }, "required": [ "color", "identifier", "type" ] }, "DetailMissingProfile": { "type": "object", "properties": { "slots": { "type": "array", "items": { "$ref": "#/components/schemas/PrinterSlot" } } }, "required": [ "slots" ] }, "DetailDataMaterialMismatch": { "type": "object", "properties": { "slots": { "type": "array", "items": { "$ref": "#/components/schemas/PrinterSlot" } }, "jobMaterialAssignments": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/RecordnumberArraySingleMaterialSpecification" } ] }, "partMaterialAssignments": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/RecordnumberArrayPartMaterialAssignment" } ] }, "computedAssignments": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/RecordnumberArrayComputedPartMaterialAssignment" } ] } }, "required": [ "slots", "jobMaterialAssignments", "partMaterialAssignments", "computedAssignments" ] }, "RecordnumberArrayPartMaterialAssignment": { "type": "object", "properties": {}, "description": "Construct a type with a set of properties K of type T", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/PartMaterialAssignment" } } }, "PartMaterialAssignment": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "storeId": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "groupId": { "oneOf": [ { "type": "null" }, { "type": "string", "pattern": "^[a-z0-9]{24}$" } ] }, "variantId": { "oneOf": [ { "type": "null" }, { "type": "string", "pattern": "^[a-z0-9]{24}$" } ] }, "materialId": { "oneOf": [ { "type": "null" }, { "type": "string", "pattern": "^[a-z0-9]{24}$" } ] }, "materialType": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "partId": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "index": { "type": "number", "minimum": 0 }, "priority": { "type": "number", "minimum": 0 } }, "required": [ "id", "storeId", "createdAt", "updatedAt", "groupId", "variantId", "materialId", "materialType", "partId", "index", "priority" ], "description": "Part material assignment entity linking parts to materials or groups" }, "RecordnumberArrayComputedPartMaterialAssignment": { "type": "object", "properties": {}, "description": "Construct a type with a set of properties K of type T", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/ComputedPartMaterialAssignment" } } }, "ComputedPartMaterialAssignment": { "type": "object", "properties": { "partId": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "priority": { "type": "number", "minimum": 0 }, "groupId": { "oneOf": [ { "type": "null" }, { "type": "string", "pattern": "^[a-z0-9]{24}$" } ] }, "materialId": { "oneOf": [ { "type": "null" }, { "type": "string", "pattern": "^[a-z0-9]{24}$" } ] }, "variantId": { "oneOf": [ { "type": "null" }, { "type": "string", "pattern": "^[a-z0-9]{24}$" } ] }, "materialType": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "index": { "type": "number", "minimum": 0 } }, "required": [ "partId", "priority", "groupId", "materialId", "variantId", "materialType", "index" ] }, "DetailDataMatched": { "type": "object", "properties": { "slots": { "type": "array", "items": { "$ref": "#/components/schemas/PrinterSlot" } } }, "required": [ "slots" ] }, "PrintJobMatchingTroubleshoot": { "type": "object", "properties": { "printJobId": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "printers": { "type": "array", "items": { "$ref": "#/components/schemas/PrinterMatchingStatus" } } }, "required": [ "printJobId", "printers" ] }, "PrinterMatchingStatus": { "type": "object", "properties": { "printerId": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "printerName": { "type": "string" }, "matched": { "type": "boolean" }, "compatible": { "type": "boolean" }, "checks": { "type": "array", "items": { "$ref": "#/components/schemas/PrinterMatchCheck" } }, "firstFailedCheck": { "oneOf": [ { "const": "enabled" }, { "const": "online" }, { "const": "available" }, { "const": "ready" }, { "const": "profiles-configured" }, { "const": "subscription-slots" }, { "const": "slots-loaded" }, { "const": "tags-match" }, { "const": "material-match" }, { "const": "filament-profiles" }, { "const": "in-maintenance" } ] } }, "required": [ "printerId", "printerName", "matched", "compatible", "checks" ] }, "PrinterMatchCheck": { "type": "object", "properties": { "code": { "oneOf": [ { "const": "enabled" }, { "const": "online" }, { "const": "available" }, { "const": "ready" }, { "const": "profiles-configured" }, { "const": "subscription-slots" }, { "const": "slots-loaded" }, { "const": "tags-match" }, { "const": "material-match" }, { "const": "filament-profiles" }, { "const": "in-maintenance" } ] }, "passed": { "type": "boolean" }, "message": { "type": "string" }, "context": { "$ref": "#/components/schemas/PrinterMatchCheckContext" } }, "required": [ "code", "passed", "message" ] }, "PrinterMatchCheckContext": { "type": "object", "properties": { "materialId": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "variantId": { "type": "string", "pattern": "^[a-z0-9]{24}$" } } }, "RunQueueResponse": { "type": "object", "properties": { "skipped": { "oneOf": [ { "const": "no-printers" }, { "const": "no-jobs" }, { "const": "no-subscription-slots" }, { "const": "auto-matching-disabled" } ] }, "assignments": { "type": "array", "items": { "$ref": "#/components/schemas/QueueMatchAssignment" } } }, "required": [ "assignments" ], "description": "Result of one queue-matcher run. Returned synchronously from the manual\n\"Match queue now\" endpoint so the operator sees what was assigned (or\nwhy the run produced nothing). The same shape backs the future\ndry-run/preview path — that variant just returns assignments without\nhaving committed them." }, "QueueMatchAssignment": { "type": "object", "properties": { "printerId": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "printJobId": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "jobLabel": { "type": "string" } }, "required": [ "printerId", "printJobId", "jobLabel" ] }, "QueueGroupMatchingResponse": { "type": "object", "properties": { "groups": { "type": "array", "items": { "$ref": "#/components/schemas/QueueGroupMatchingEntry" } } }, "required": [ "groups" ] }, "QueueGroupMatchingEntry": { "type": "object", "properties": { "groupId": { "oneOf": [ { "type": "null" }, { "type": "string", "pattern": "^[a-z0-9]{24}$" } ], "description": "Group identifier shared by every job in the entry. Null for legacy rows\nthat predate the queue-grouping feature — those rows form a singleton\n\"group of one\" keyed by the job id." }, "representativePrintJobId": { "type": "string", "pattern": "^[a-z0-9]{24}$", "title": "Job whose part/materials/tags drive the printer evaluation", "description": "Job whose part/materials/tags drive the printer evaluation." }, "memberPrintJobIds": { "type": "array", "items": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "title": "All print job IDs from the request scope that share this groupId", "description": "All print job IDs from the request scope that share this groupId." }, "printers": { "type": "array", "items": { "$ref": "#/components/schemas/PrinterMatchingStatus" }, "description": "Per-printer compatibility result for the representative job. Same shape\nthe troubleshooter returns, ordered matched → compatible → name." } }, "required": [ "groupId", "representativePrintJobId", "memberPrintJobIds", "printers" ] }, "QueueGroupMatchingRequest": { "type": "object", "properties": { "printJobIds": { "type": "array", "items": { "type": "string", "pattern": "^[a-z0-9]{24}$" } } }, "description": "Request body for the bulk group-matching endpoint. When `printJobIds` is\nomitted the server scans every currently-pending unassigned job in the\nstore. When supplied, only those jobs are considered (still de-duped by\ngroupId so each group is evaluated once)." }, "SendPrintJobToPrinterResponse": { "type": "object", "properties": { "printJob": { "$ref": "#/components/schemas/PrintJob" } }, "required": [ "printJob" ] }, "SendPrintJobToPrinterRequest": { "type": "object", "properties": { "printerId": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "force": { "type": "boolean", "description": "When true, bypass the printer-job match check. The server still enforces\nthe atomic \"printer not currently busy\" claim and the part-existence\nguard. Use sparingly — a forced mismatch will likely fail at slice/print\ntime." } }, "required": [ "printerId" ], "description": "Request body for the direct-send endpoint. Sends a specific pending job to\na specific printer without running global queue matching." }, "ReorderPrintJobRequest": { "type": "object", "properties": { "newQueueOrder": { "type": "number", "minimum": 0 }, "priority": { "type": "number" } } }, "BulkReorderPrintJobsRequest": { "type": "object", "properties": { "updates": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "newQueueOrder": { "type": "number", "minimum": 0 }, "priority": { "type": "number" } }, "required": [ "id" ] } } }, "required": [ "updates" ] }, "PartialPrintJobInsert": { "type": "object", "properties": { "overriddenProcessProfileId": { "oneOf": [ { "type": "null" }, { "type": "string", "pattern": "^[a-z0-9]{24}$" } ] }, "thumbnailUri": { "oneOf": [ { "type": "null" }, { "type": "string", "minLength": 1 } ] }, "partId": { "oneOf": [ { "type": "null" }, { "type": "string", "pattern": "^[a-z0-9]{24}$" } ] }, "skuId": { "oneOf": [ { "type": "null" }, { "type": "string", "pattern": "^[a-z0-9]{24}$" } ] }, "status": { "oneOf": [ { "const": "pending" }, { "const": "assigned" }, { "const": "slicing" }, { "const": "sliced" }, { "const": "finalizing" }, { "const": "waiting-for-approval" }, { "const": "ready-for-printer" }, { "const": "sending-to-printer" }, { "const": "printing" }, { "const": "paused" }, { "const": "completed" }, { "const": "failed" }, { "const": "cancelled" } ] }, "priority": { "oneOf": [ { "const": 100 }, { "const": 1000 } ] }, "skuName": { "oneOf": [ { "type": "null" }, { "type": "string", "minLength": 1 } ] }, "label": { "type": "string" }, "requiredPrinterTags": { "$ref": "#/components/schemas/Tags" }, "parameterOverrides": { "type": "array", "items": { "$ref": "#/components/schemas/PartParameterOverride" } }, "assignmentStartedAt": { "oneOf": [ { "type": "null" }, { "type": "string", "format": "date-time" } ] }, "extensions": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/PrintJobExtensions" } ] }, "materialAssignments": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/RecordnumberArraySingleMaterialSpecification" } ] }, "partBuildId": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "quantityIndex": { "type": "number" }, "quantityTotal": { "type": "number" }, "filesToPrint": { "type": "array", "items": { "type": "string", "minLength": 1 } }, "partName": { "type": "string", "minLength": 1, "maxLength": 1024 }, "skipObjectsData": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/SkipObjectsData" } ] }, "orderId": { "oneOf": [ { "type": "null" }, { "type": "string", "pattern": "^[a-z0-9]{24}$" } ] }, "orderItemId": { "oneOf": [ { "type": "null" }, { "type": "string", "pattern": "^[a-z0-9]{24}$" } ] }, "linkedPartId": { "oneOf": [ { "type": "null" }, { "type": "string", "pattern": "^[a-z0-9]{24}$" } ] }, "buildThumbnailUri": { "oneOf": [ { "type": "null" }, { "type": "string", "minLength": 1 } ] }, "queueOrder": { "type": "number", "minimum": 0 }, "skipObjectIds": { "oneOf": [ { "type": "null" }, { "type": "array", "items": { "type": "string" } } ], "description": "User-selected objects to skip on this job's plate, as identifyId strings\n(resolved at queue time from the part's plate object list). When the print\nstarts, a Bambu `skip_objects` command is auto-sent for these. Null/empty\nmeans print everything. Stored as strings; converted to integer obj_list at\nsend time." }, "skuInstance": { "oneOf": [ { "type": "null" }, { "type": "number" } ] }, "groupId": { "oneOf": [ { "type": "null" }, { "type": "string", "pattern": "^[a-z0-9]{24}$" } ], "description": "Group identifier for visually-collapsed print-queue rows. Assigned at\nemission (one per plate cluster within a build). Split mints fresh\ngroupIds for non-first buckets. May be null for legacy rows that predate\nthe grouping feature." } }, "description": "Make all properties in T optional" }, "Store": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 1024 }, "timezone": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "country": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "logoLightUrl": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "logoDarkUrl": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "websiteUrl": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "auditEnabled": { "type": "boolean" }, "id": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "updatedAt": { "type": "string", "format": "date-time" }, "createdAt": { "type": "string", "format": "date-time" } }, "required": [ "name", "auditEnabled", "id", "updatedAt", "createdAt" ] }, "StoreUpdate": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 1024 }, "timezone": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "country": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "logoLightUploadPath": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "logoDarkUploadPath": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "websiteUrl": { "oneOf": [ { "type": "null" }, { "type": "string" } ] } } }, "SkuLinkedPartsRelation": { "type": "object", "properties": { "sku": { "type": "string", "minLength": 1, "maxLength": 1024 }, "title": { "type": "string" }, "description": { "type": "string" }, "externalId": { "oneOf": [ { "type": "null" }, { "type": "string", "minLength": 1, "maxLength": 1024 } ] }, "externalProvider": { "oneOf": [ { "type": "null" }, { "const": "etsy" }, { "const": "shopify" } ] }, "folderId": { "oneOf": [ { "type": "null" }, { "type": "string", "pattern": "^[a-z0-9]{24}$" } ] }, "totalCogs": { "type": "number" }, "id": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "storeId": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "linkedParts": { "type": "array", "items": { "$ref": "#/components/schemas/LinkedPart" } } }, "required": [ "sku", "title", "description", "externalId", "externalProvider", "totalCogs", "id", "storeId", "createdAt", "updatedAt", "linkedParts" ] }, "skustringundefinedtitlestringundefineddescriptionstringundefinedexternalIdstringundefinedexternalProviderstringundefinedfolderIdstringundefined...4more...updatedAtstringundefinedQuerySettings...": { "type": "object", "properties": { "sku": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "externalId": { "type": "string" }, "externalProvider": { "type": "string" }, "folderId": { "type": "string" }, "totalCogs": { "type": "string" }, "id": { "type": "string" }, "storeId": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "sort": { "type": "string", "title": "Sort", "description": "Sort specification in format \"field:asc,field2:desc\"" }, "limit": { "type": "number", "minimum": 1, "maximum": 1000, "title": "Limit", "description": "Maximum number of results to return (default: 100, max: 1000)" }, "offset": { "type": "number", "minimum": 0, "title": "Offset", "description": "Number of results to skip for pagination" }, "fields": { "type": "string", "title": "Fields", "description": "Comma-separated list of fields to return" }, "include": { "type": "string", "title": "Include", "description": "Comma-separated list of relations to include (max 4, max 2 levels deep).\nExample: \"linkedParts,linkedParts.part,folder\"" }, "meta": { "type": "boolean", "title": "Meta", "description": "If true, returns response with metadata (total, count, hasMore, etc.)" }, "hints": { "type": "boolean", "title": "Hints", "description": "If true, returns AI-friendly hints about available actions. Implies meta=true." } } }, "SearchQueryDtoSku": { "type": "object", "properties": { "filter": { "oneOf": [ { "$ref": "#/components/schemas/LogicalConditionSku" }, { "$ref": "#/components/schemas/FieldConditionSku" } ], "title": "Filter", "description": "Complex filter conditions using logical and field operators.\nAvailable field operators: eq, ne, gt, gte, lt, lte, contains, startsWith, endsWith, in, notIn, isNull, between.\nUsage example: {\"filter\": {\"and\": [{\"name\": {\"contains\": \"benchy\"}}, {\"or\": [{\"type\": {\"eq\": \"3mf\"}}, {\"type\": {\"eq\": \"gcode3mf\"}}]}}}" }, "sort": { "type": "string", "title": "Sort", "description": "Sort specification in format \"field:asc,field2:desc\"" }, "limit": { "type": "number", "minimum": 1, "maximum": 1000, "title": "Limit", "description": "Maximum number of results to return (default: 100, max: 1000)" }, "offset": { "type": "number", "minimum": 0, "title": "Offset", "description": "Number of results to skip for pagination" }, "fields": { "type": "string", "title": "Fields", "description": "Comma-separated list of fields to return" }, "include": { "type": "string", "title": "Include", "description": "Comma-separated list of relations to include (max 4, max 2 levels deep).\nExample: \"linkedParts,linkedParts.part,folder\"" }, "meta": { "type": "boolean", "title": "Meta", "description": "If true, returns response with metadata (total, count, hasMore, etc.)" }, "hints": { "type": "boolean", "title": "Hints", "description": "If true, returns AI-friendly hints about available actions. Implies meta=true." } }, "title": "Search Query", "description": "Complete search request with filter conditions and query settings" }, "LogicalConditionSku": { "type": "object", "properties": { "and": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/LogicalConditionSku" }, { "$ref": "#/components/schemas/FieldConditionSku" } ] }, "title": "AND Conditions", "description": "All conditions must be true" }, "or": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/LogicalConditionSku" }, { "$ref": "#/components/schemas/FieldConditionSku" } ] }, "title": "OR Conditions", "description": "At least one condition must be true" } }, "title": "Logical Condition", "description": "Logical operators for combining multiple filter conditions" }, "FieldConditionSku": { "type": "object", "properties": { "sku": { "$ref": "#/components/schemas/FieldOperators" }, "title": { "$ref": "#/components/schemas/FieldOperators" }, "description": { "$ref": "#/components/schemas/FieldOperators" }, "externalId": { "$ref": "#/components/schemas/FieldOperators" }, "externalProvider": { "$ref": "#/components/schemas/FieldOperators" }, "folderId": { "$ref": "#/components/schemas/FieldOperators" }, "totalCogs": { "$ref": "#/components/schemas/FieldOperators" }, "id": { "$ref": "#/components/schemas/FieldOperators" }, "storeId": { "$ref": "#/components/schemas/FieldOperators" }, "createdAt": { "$ref": "#/components/schemas/FieldOperators" }, "updatedAt": { "$ref": "#/components/schemas/FieldOperators" } }, "title": "Field Condition", "description": "Field-based filter conditions where keys are field names and values are field operators" }, "SkuLinkedPartsWithPartRelation": { "type": "object", "properties": { "sku": { "type": "string", "minLength": 1, "maxLength": 1024 }, "title": { "type": "string" }, "description": { "type": "string" }, "externalId": { "oneOf": [ { "type": "null" }, { "type": "string", "minLength": 1, "maxLength": 1024 } ] }, "externalProvider": { "oneOf": [ { "type": "null" }, { "const": "etsy" }, { "const": "shopify" } ] }, "folderId": { "oneOf": [ { "type": "null" }, { "type": "string", "pattern": "^[a-z0-9]{24}$" } ] }, "totalCogs": { "type": "number" }, "id": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "storeId": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "linkedParts": { "type": "array", "items": { "$ref": "#/components/schemas/LinkedPartPartRelation" } } }, "required": [ "sku", "title", "description", "externalId", "externalProvider", "totalCogs", "id", "storeId", "createdAt", "updatedAt", "linkedParts" ] }, "LinkedPartPartRelation": { "type": "object", "properties": { "skuId": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "partId": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "parameters": { "type": "array", "items": { "$ref": "#/components/schemas/PartParameterOverride" } }, "quantity": { "type": "number", "minimum": 0, "maximum": 500 }, "label": { "type": "string", "minLength": 1, "maxLength": 1024 }, "exposedParameters": { "type": "array", "items": { "type": "string" } }, "materialAssignments": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/RecordnumberArrayLinkedPartMaterialSpecification" } ] }, "extensions": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/LinkedPartExtensions" } ] }, "parameterBindings": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/Recordstringstring" } ] }, "plateQuantitiesBinding": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "id": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "storeId": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "part": { "$ref": "#/components/schemas/Part" } }, "required": [ "skuId", "partId", "parameters", "quantity", "label", "exposedParameters", "id", "storeId", "createdAt", "updatedAt", "part" ] }, "SkuInsert": { "type": "object", "properties": { "linkedParts": { "type": "array", "items": { "$ref": "#/components/schemas/LinkedPartInsert" } }, "inputs": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "oneOf": [ { "const": "text" }, { "const": "material" }, { "const": "plate_quantities" } ] }, "name": { "type": "string" }, "connectedPropertyId": { "oneOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": [ "type", "name" ] } }, "optionBindings": { "type": "array", "items": { "type": "string" } }, "externalId": { "oneOf": [ { "type": "null" }, { "type": "string", "minLength": 1, "maxLength": 1024 } ] }, "description": { "type": "string" }, "folderId": { "oneOf": [ { "type": "null" }, { "type": "string", "pattern": "^[a-z0-9]{24}$" } ] }, "sku": { "type": "string", "minLength": 1, "maxLength": 1024 }, "title": { "type": "string" }, "externalProvider": { "oneOf": [ { "type": "null" }, { "const": "etsy" }, { "const": "shopify" } ] } }, "required": [ "linkedParts", "externalId", "description", "sku", "title", "externalProvider" ] }, "PartialSkuInsert": { "type": "object", "properties": { "linkedParts": { "type": "array", "items": { "$ref": "#/components/schemas/LinkedPartInsert" } }, "inputs": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "oneOf": [ { "const": "text" }, { "const": "material" }, { "const": "plate_quantities" } ] }, "name": { "type": "string" }, "connectedPropertyId": { "oneOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": [ "type", "name" ] } }, "optionBindings": { "type": "array", "items": { "type": "string" } }, "externalId": { "oneOf": [ { "type": "null" }, { "type": "string", "minLength": 1, "maxLength": 1024 } ] }, "description": { "type": "string" }, "folderId": { "oneOf": [ { "type": "null" }, { "type": "string", "pattern": "^[a-z0-9]{24}$" } ] }, "sku": { "type": "string", "minLength": 1, "maxLength": 1024 }, "title": { "type": "string" }, "externalProvider": { "oneOf": [ { "type": "null" }, { "const": "etsy" }, { "const": "shopify" } ] } }, "description": "Make all properties in T optional" }, "BuildResultV2": { "type": "object", "properties": { "partBuilds": { "type": "array", "items": { "$ref": "#/components/schemas/PartBuild" }, "description": "Created part build records" }, "skuBuilds": { "type": "array", "items": { "$ref": "#/components/schemas/SkuBuild" }, "description": "Created SKU build records" } }, "required": [ "partBuilds", "skuBuilds" ], "description": "Result of a successful build creation operation\nContains the created part builds and SKU builds with their assigned IDs" }, "PartBuild": { "type": "object", "properties": { "partId": { "oneOf": [ { "type": "null" }, { "type": "string", "pattern": "^[a-z0-9]{24}$" } ] }, "skuBuildId": { "oneOf": [ { "type": "null" }, { "type": "string", "pattern": "^[a-z0-9]{24}$" } ] }, "skuId": { "oneOf": [ { "type": "null" }, { "type": "string", "pattern": "^[a-z0-9]{24}$" } ] }, "skuName": { "oneOf": [ { "type": "null" }, { "type": "string", "minLength": 1, "maxLength": 1024 } ] }, "label": { "oneOf": [ { "type": "null" }, { "type": "string", "minLength": 1, "maxLength": 1024 } ] }, "partCopy": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 1024 }, "type": { "oneOf": [ { "const": "scad" }, { "const": "cadquery" }, { "const": "build123d" }, { "const": "stl" }, { "const": "step" }, { "const": "3mf" }, { "const": "gcode3mf" }, { "const": "gcode" } ] }, "description": { "type": "string", "default": "" }, "fileUris": { "type": "array", "items": { "type": "string" } }, "fileHashes": { "type": "array", "items": { "type": "string" } }, "thumbnailUri": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "parameters": { "type": "array", "items": { "type": "object", "properties": { "default": { "oneOf": [ { "type": "number" }, { "type": "string", "minLength": 0, "maxLength": 255 }, { "type": "boolean" } ] }, "options": { "type": "array", "items": { "type": "object", "properties": { "value": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "label": { "type": "string" } }, "required": [ "value" ] } }, "description": { "type": "string" }, "min": { "type": "number" }, "max": { "type": "number" }, "step": { "type": "number" }, "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "type": { "oneOf": [ { "const": "number" }, { "const": "string" }, { "const": "boolean" } ] }, "value": { "oneOf": [ { "type": "number" }, { "type": "string", "minLength": 0, "maxLength": 255 }, { "type": "boolean" } ] } }, "required": [ "name", "type" ] } }, "printTags": { "type": "object", "properties": { "printer.provider": { "type": "string", "minLength": 1 }, "printer.id": { "type": "string", "minLength": 1 }, "printer.nozzleDiameter": { "type": "string", "minLength": 1 }, "printer.modelName": { "type": "string", "minLength": 1 }, "filament.type": { "type": "string", "minLength": 1 }, "user.tags": { "type": "string", "minLength": 1 } } }, "overriddenProcessProfileId": { "oneOf": [ { "type": "null" }, { "type": "string", "pattern": "^[a-z0-9]{24}$" } ] }, "folderId": { "oneOf": [ { "type": "null" }, { "type": "string", "pattern": "^[a-z0-9]{24}$" } ] }, "materials": { "oneOf": [ { "type": "null" }, { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "number", "minimum": 0 }, "color": { "oneOf": [ { "type": "null" }, { "type": "string", "pattern": "^#{0,1}[0-9A-F]{6}|[0-9A-F]{8}$" } ] }, "type": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "skip": { "type": "boolean" }, "name": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "identifier": { "oneOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": [ "index", "color", "type" ] } } ] }, "slicerOverride": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "metadata": { "oneOf": [ { "type": "null" }, { "type": "object", "properties": { "printerModel": { "type": "string" }, "filamentType": { "type": "array", "items": { "type": "string" } }, "filamentColors": { "type": "array", "items": { "type": "string" } }, "filamentDensities": { "type": "array", "items": { "type": "number" } }, "filamentDiameters": { "type": "array", "items": { "type": "number" } }, "nozzleDiameter": { "type": "string" }, "profileCompat": { "type": "object", "properties": { "sliced": { "type": "string" }, "compatible": { "type": "array", "items": { "type": "string" } }, "safe": { "type": "array", "items": { "type": "string" } } }, "required": [ "sliced", "compatible", "safe" ] }, "slicerVersion": { "oneOf": [ { "type": "null" }, { "type": "object", "properties": { "engine": { "oneOf": [ { "const": "orcaslicer" }, { "const": "bambu-studio" }, { "const": "prusaslicer" }, { "const": "superslicer" } ] }, "version": { "type": "string" } }, "required": [ "engine", "version" ] } ] }, "plates": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "locked": { "type": "boolean" }, "filamentMapMode": { "type": "string" }, "filamentMaps": { "type": "array", "items": { "type": "number" } }, "gcodeFile": { "type": "string" }, "thumbnailFile": { "type": "string" }, "thumbnailUploadedUri": { "type": "string" }, "thumbnailNoLightFile": { "type": "string" }, "thumbnailData": { "type": "string" }, "topFile": { "type": "string" }, "pickFile": { "type": "string" }, "topData": { "type": "string", "title": "Base64 PNG data for the top/pick images, staged before upload then cleared", "description": "Base64 PNG data for the top/pick images, staged before upload then cleared." }, "pickData": { "type": "string" }, "topUploadedUri": { "type": "string", "title": "Uploaded URIs for the plate's top-down image and color-coded object pick mask", "description": "Uploaded URIs for the plate's top-down image and color-coded object pick mask.\nUsed by the visual skip-objects picker." }, "pickUploadedUri": { "type": "string" }, "patternBboxFile": { "type": "string" }, "sliced": { "type": "object", "properties": { "index": { "type": "number" }, "extruderType": { "type": "string" }, "nozzleVolumeType": { "type": "string" }, "printerModelId": { "type": "string" }, "nozzleDiameters": { "type": "string" }, "timelapseType": { "type": "string" }, "prediction": { "type": "number" }, "weight": { "type": "number" }, "outside": { "type": "boolean" }, "supportUsed": { "type": "boolean" }, "labelObjectEnabled": { "type": "boolean" }, "filamentMaps": { "type": "string" }, "objects": { "type": "array", "items": { "type": "object", "properties": { "identifyId": { "type": "string" }, "name": { "type": "string" }, "skipped": { "type": "boolean" } }, "required": [ "identifyId", "name", "skipped" ] } }, "filaments": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "trayInfoIdx": { "type": "string" }, "type": { "type": "string" }, "color": { "type": "string" }, "usedM": { "type": "number" }, "usedG": { "type": "number" } }, "required": [ "id", "trayInfoIdx", "type", "color", "usedM", "usedG" ] } }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "msg": { "type": "string" }, "level": { "type": "number" }, "errorCode": { "type": "string" } }, "required": [ "msg", "level", "errorCode" ] } }, "layerFilamentLists": { "type": "array", "items": { "type": "object", "properties": { "filamentList": { "type": "number" }, "layerRanges": { "type": "string" } }, "required": [ "filamentList", "layerRanges" ] } } } }, "filamentIds": { "type": "array", "items": { "type": "string" } } }, "required": [ "id" ] } }, "filamentIds": { "type": "array", "items": { "type": "string" } } }, "required": [ "printerModel", "filamentType", "filamentColors", "nozzleDiameter", "profileCompat" ] } ] }, "slicingEstimate": { "oneOf": [ { "type": "null" }, { "type": "object", "properties": { "estimatedPrintTimeSeconds": { "type": "number" }, "materials": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "number" }, "usedGrams": { "type": "number" }, "usedMeters": { "type": "number" }, "materialType": { "type": "string" }, "color": { "type": "string" } }, "required": [ "index", "usedGrams", "usedMeters", "materialType" ] } }, "totalWeightGrams": { "type": "number" }, "profiles": { "type": "object", "properties": { "machineProfileId": { "type": "string" }, "machineProfileName": { "type": "string" }, "processProfileId": { "type": "string" }, "processProfileName": { "type": "string" }, "filamentProfileIds": { "type": "array", "items": { "type": "string" } }, "filamentProfileNames": { "type": "array", "items": { "type": "string" } } }, "required": [ "machineProfileId", "machineProfileName", "processProfileId", "processProfileName", "filamentProfileIds", "filamentProfileNames" ] }, "slicedAt": { "type": "string" }, "slicerVersion": { "type": "string" }, "plates": { "type": "array", "items": { "type": "object", "properties": { "plateId": { "type": "number" }, "estimatedPrintTimeSeconds": { "type": "number" }, "materials": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "number" }, "usedGrams": { "type": "number" }, "usedMeters": { "type": "number" }, "materialType": { "type": "string" }, "color": { "type": "string" } }, "required": [ "index", "usedGrams", "usedMeters", "materialType" ] } }, "totalWeightGrams": { "type": "number" } }, "required": [ "plateId", "estimatedPrintTimeSeconds", "materials", "totalWeightGrams" ] } } }, "required": [ "estimatedPrintTimeSeconds", "materials", "totalWeightGrams", "slicedAt", "slicerVersion" ] } ] }, "use3MFProcessProfile": { "type": "boolean" }, "arrangeable": { "type": "boolean" }, "userTags": { "type": "array", "items": { "type": "string" } }, "gcodePlateUris": { "oneOf": [ { "type": "null" }, { "type": "object", "properties": {}, "additionalProperties": { "type": "string" } } ] }, "uploadedAt": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "id": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "storeId": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "name", "type", "description", "fileUris", "fileHashes", "thumbnailUri", "parameters", "printTags", "overriddenProcessProfileId", "materials", "id", "storeId", "createdAt", "updatedAt" ] }, "requiredPrinterTags": { "$ref": "#/components/schemas/Tags" }, "quantity": { "type": "number", "minimum": 0, "maximum": 500 }, "numPartsPerSku": { "oneOf": [ { "type": "null" }, { "type": "number" } ] }, "skuInstanceStart": { "oneOf": [ { "type": "null" }, { "type": "number" } ] }, "parameterOverrides": { "type": "array", "items": { "$ref": "#/components/schemas/PartParameterOverride" } }, "status": { "oneOf": [ { "const": "pending" }, { "const": "building" }, { "const": "queued" }, { "const": "fulfilling" }, { "const": "preparing" }, { "const": "sending-to-printer" }, { "const": "printing" }, { "const": "success" }, { "const": "error" }, { "const": "cancelled" } ] }, "outputFiles": { "oneOf": [ { "type": "null" }, { "type": "array", "items": { "type": "string" } } ] }, "thumbnailUri": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "assignmentStartedAt": { "oneOf": [ { "type": "null" }, { "type": "string", "format": "date-time" } ] }, "assignmentCompletedAt": { "oneOf": [ { "type": "null" }, { "type": "string", "format": "date-time" } ] }, "printingStartedAt": { "oneOf": [ { "type": "null" }, { "type": "string", "format": "date-time" } ] }, "printingCompletedAt": { "oneOf": [ { "type": "null" }, { "type": "string", "format": "date-time" } ] }, "printStatus": { "oneOf": [ { "const": "pending" }, { "const": "printing" }, { "const": "success" }, { "const": "error" }, { "const": "cancelled" } ] }, "extensions": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/PartBuildExtensions" } ] }, "materialAssignments": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/MaterialAssignments" } ] }, "priority": { "oneOf": [ { "const": 100 }, { "const": 1000 } ] }, "position": { "oneOf": [ { "const": "front" }, { "const": "back" } ] }, "orderId": { "oneOf": [ { "type": "null" }, { "type": "string", "pattern": "^[a-z0-9]{24}$" } ] }, "orderItemId": { "oneOf": [ { "type": "null" }, { "type": "string", "pattern": "^[a-z0-9]{24}$" } ] }, "linkedPartId": { "oneOf": [ { "type": "null" }, { "type": "string", "pattern": "^[a-z0-9]{24}$" } ] }, "dismissed": { "type": "boolean" }, "id": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "storeId": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "partId", "skuBuildId", "skuId", "skuName", "label", "partCopy", "requiredPrinterTags", "quantity", "parameterOverrides", "status", "outputFiles", "thumbnailUri", "assignmentStartedAt", "assignmentCompletedAt", "printingStartedAt", "printingCompletedAt", "printStatus", "materialAssignments", "priority", "position", "orderId", "orderItemId", "linkedPartId", "dismissed", "id", "storeId", "createdAt", "updatedAt" ] }, "PartBuildExtensions": { "type": "object", "properties": { "3mf": { "$ref": "#/components/schemas/PartBuildExtension3MF" }, "orderInfo": { "$ref": "#/components/schemas/PartBuildOrderInfo" } } }, "PartBuildExtension3MF": { "type": "object", "properties": { "plateQuantities": { "$ref": "#/components/schemas/PartExtension3MFPlateQuantities" }, "skipObjects": { "$ref": "#/components/schemas/RecordstringArraystring", "title": "Objects to SKIP per plate, keyed by plate id, as identifyId strings (Bambu only)", "description": "Objects to SKIP per plate, keyed by plate id, as identifyId strings (Bambu only)." }, "plateLabels": { "$ref": "#/components/schemas/PartExtension3MFPlateLabels" } } }, "RecordstringArraystring": { "type": "object", "properties": {}, "description": "Construct a type with a set of properties K of type T", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "PartBuildOrderInfo": { "type": "object", "properties": { "linkedPartId": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "linkedPartQuantity": { "type": "number" } }, "required": [ "linkedPartId", "linkedPartQuantity" ] }, "MaterialAssignments": { "type": "object", "properties": {}, "additionalProperties": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "groupId": { "type": "string", "pattern": "^[a-z0-9]{24}$" } }, "required": [ "groupId" ] }, { "type": "object", "properties": { "variantId": { "type": "string", "pattern": "^[a-z0-9]{24}$" } }, "required": [ "variantId" ] }, { "type": "object", "properties": { "materialId": { "type": "string", "pattern": "^[a-z0-9]{24}$" } }, "required": [ "materialId" ] }, { "type": "object", "properties": { "materialType": { "type": "string" } }, "required": [ "materialType" ] } ] } } }, "SkuBuild": { "type": "object", "properties": { "skuId": { "oneOf": [ { "type": "null" }, { "type": "string", "pattern": "^[a-z0-9]{24}$" } ] }, "skuCopy": { "type": "object", "properties": { "sku": { "type": "string", "minLength": 1, "maxLength": 1024 }, "title": { "type": "string" }, "description": { "type": "string" }, "externalId": { "oneOf": [ { "type": "null" }, { "type": "string", "minLength": 1, "maxLength": 1024 } ] }, "externalProvider": { "oneOf": [ { "type": "null" }, { "const": "etsy" }, { "const": "shopify" } ] }, "folderId": { "oneOf": [ { "type": "null" }, { "type": "string", "pattern": "^[a-z0-9]{24}$" } ] }, "totalCogs": { "type": "number" }, "id": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "storeId": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "sku", "title", "description", "externalId", "externalProvider", "totalCogs", "id", "storeId", "createdAt", "updatedAt" ] }, "status": { "oneOf": [ { "const": "pending" }, { "const": "running" }, { "const": "success" }, { "const": "error" }, { "const": "cancelled" } ] }, "skuInstanceStart": { "oneOf": [ { "type": "null" }, { "type": "number" } ] }, "orderId": { "oneOf": [ { "type": "null" }, { "type": "string", "pattern": "^[a-z0-9]{24}$" } ] }, "orderItemId": { "oneOf": [ { "type": "null" }, { "type": "string", "pattern": "^[a-z0-9]{24}$" } ] }, "priority": { "oneOf": [ { "const": 100 }, { "const": 1000 } ] }, "selectedOptions": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/Recordstringstringnull" } ] }, "id": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "storeId": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "skuId", "skuCopy", "status", "orderId", "orderItemId", "priority", "id", "storeId", "createdAt", "updatedAt" ] }, "Recordstringstringnull": { "type": "object", "properties": {}, "description": "Construct a type with a set of properties K of type T", "additionalProperties": { "oneOf": [ { "type": "null" }, { "type": "string" } ] } }, "BuildConfigV2": { "type": "object", "properties": { "parts": { "type": "array", "items": { "$ref": "#/components/schemas/PartBuildConfigV2" }, "description": "Individual parts to print" }, "skus": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/skuIdCuid2quantityQuantityMin1undefinedlinkedPartConfigsRecordCuid2LinkedPartConfigV2undefined...5more...optionsSkuOptionSpecundefined" }, { "$ref": "#/components/schemas/skustringquantityQuantityMin1undefinedlinkedPartConfigsRecordCuid2LinkedPartConfigV2undefined...5more...optionsSkuOptionSpecundefined" } ] }, "description": "SKUs (product bundles) to print" } }, "description": "Configuration for creating a new build containing parts and/or SKUs" }, "PartBuildConfigV2": { "type": "object", "properties": { "partId": { "type": "string", "pattern": "^[a-z0-9]{24}$", "description": "ID of the part to print" }, "priority": { "oneOf": [ { "const": 100 }, { "const": 1000 } ], "description": "Priority level for print job queue processing" }, "position": { "oneOf": [ { "const": "front" }, { "const": "back" } ], "description": "Position in the queue: 'front' places jobs at front of priority tier, 'back' at end" }, "quantity": { "type": "number", "minimum": 0, "maximum": 500, "title": "Number of copies to print", "description": "Number of copies to print." }, "parameters": { "$ref": "#/components/schemas/Parameters", "description": "Custom parameters to override part defaults" }, "label": { "type": "string", "minLength": 1, "maxLength": 1024, "title": "Custom label for this part in the build", "description": "Custom label for this part in the build." }, "tags": { "$ref": "#/components/schemas/Tags", "description": "Tags to categorize or filter this part" }, "plateQuantities": { "$ref": "#/components/schemas/PartExtension3MFPlateQuantities", "description": "Quantity distribution across plates. Only applies to 3MF and GCODE 3MF files" }, "plateLabels": { "$ref": "#/components/schemas/PartExtension3MFPlateLabels", "title": "Per-plate label overrides keyed by plate ID. Only applies to 3MF and GCODE 3MF files", "description": "Per-plate label overrides keyed by plate ID. Only applies to 3MF and GCODE 3MF files.\n\nWhen set, the print job label for that plate becomes `${label} - ${plateLabels[plateId]}`\ninstead of the plate's name embedded in the file." }, "materials": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/RecordnumberArraySingleMaterialSpecification" } ], "description": "Material assignments per extruder/channel (channel index -> material specifications)" }, "skipObjects": { "$ref": "#/components/schemas/RecordstringArraystring", "title": "Objects to SKIP per plate, keyed by plate id, as identifyId strings", "description": "Objects to SKIP per plate, keyed by plate id, as identifyId strings.\n\nBambu only. The print starts normally and a `skip_objects` command is sent\nfor these objects once the printer reports it has started. identifyIds come\nfrom `part.metadata.plates[].sliced.objects[]`. Objects not listed are printed." } }, "required": [ "partId" ], "description": "Configuration for building a specific part" }, "Parameters": { "type": "object", "properties": {}, "description": "Key-value pairs of parameter names to their values for customizing parts", "additionalProperties": { "oneOf": [ { "type": "number" }, { "type": "string", "minLength": 0, "maxLength": 255 }, { "type": "boolean" } ] } }, "skuIdCuid2quantityQuantityMin1undefinedlinkedPartConfigsRecordCuid2LinkedPartConfigV2undefined...5more...optionsSkuOptionSpecundefined": { "type": "object", "properties": { "skuId": { "type": "string", "pattern": "^[a-z0-9]{24}$", "description": "Internal unique identifier for the SKU" }, "quantity": { "type": "number", "minimum": 1, "maximum": 500, "description": "Number of complete SKU units to build\n\nThis value is multiplied by the quantity configured on each linked part, respecting any quantity overrides defined in linkedPartConfigs." }, "linkedPartConfigs": { "$ref": "#/components/schemas/RecordCuid2LinkedPartConfigV2", "description": "Configuration overrides for specific parts within this SKU (partId -> config)" }, "tags": { "$ref": "#/components/schemas/Tags", "description": "Tags to categorize or filter this SKU" }, "priority": { "oneOf": [ { "const": 100 }, { "const": 1000 } ], "description": "Priority level for all parts in this SKU build" }, "position": { "oneOf": [ { "const": "front" }, { "const": "back" } ], "description": "Position in the queue: 'front' places jobs at front of priority tier, 'back' at end" }, "skuInstanceStart": { "type": "number", "minimum": 1, "description": "Starting SKU instance number for tracking (1-based)\nUsed internally for order reconciliation" }, "order": { "$ref": "#/components/schemas/OmitOrderInfoV2linkedPartId", "description": "Order information for tracking this SKU build to an order" }, "options": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "value": { "type": "string" } }, "required": [ "id", "value" ] }, { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "string" } }, "required": [ "name", "value" ] } ] }, "description": "SKU options selected for this build\nArray of option selections that can reference options by ID or name\nThese will be converted to selectedOptions format (optionId -> value name)" } }, "required": [ "skuId" ] }, "RecordCuid2LinkedPartConfigV2": { "type": "object", "properties": {}, "description": "Construct a type with a set of properties K of type T", "additionalProperties": { "$ref": "#/components/schemas/LinkedPartConfigV2" } }, "LinkedPartConfigV2": { "type": "object", "properties": { "parameters": { "$ref": "#/components/schemas/Parameters", "description": "Custom parameters to override part defaults" }, "tags": { "$ref": "#/components/schemas/Tags", "description": "Tags to categorize or filter this part" }, "quantity": { "type": "number", "minimum": 0, "maximum": 500, "title": "Number of copies to print", "description": "Number of copies to print." }, "label": { "type": "string", "minLength": 1, "maxLength": 1024, "title": "Custom label for this part in the build", "description": "Custom label for this part in the build." }, "plateQuantities": { "$ref": "#/components/schemas/PartExtension3MFPlateQuantities", "description": "Quantity distribution across plates. Only applies to 3MF and GCODE 3MF files" }, "plateLabels": { "$ref": "#/components/schemas/PartExtension3MFPlateLabels", "title": "Per-plate label overrides keyed by plate ID. Only applies to 3MF and GCODE 3MF files", "description": "Per-plate label overrides keyed by plate ID. Only applies to 3MF and GCODE 3MF files.\n\nWhen set, the print job label for that plate becomes `${label} - ${plateLabels[plateId]}`\ninstead of the plate's name embedded in the file." }, "skipObjects": { "$ref": "#/components/schemas/RecordstringArraystring", "title": "Objects to SKIP per plate, keyed by plate id, as identifyId strings", "description": "Objects to SKIP per plate, keyed by plate id, as identifyId strings.\n\nBambu only. The print starts normally and a `skip_objects` command is sent\nfor these objects once the printer reports it has started. identifyIds come\nfrom `part.metadata.plates[].sliced.objects[]`. Objects not listed are printed." }, "materials": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/RecordnumberArrayLinkedPartMaterialSpecification" } ] } }, "description": "Additional configuration/overrides for linked parts within a SKU build" }, "OmitOrderInfoV2linkedPartId": { "type": "object", "properties": { "orderId": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "orderItemId": { "type": "string", "pattern": "^[a-z0-9]{24}$" } }, "required": [ "orderId", "orderItemId" ], "description": "Construct a type with the properties of T except for those in type K." }, "skustringquantityQuantityMin1undefinedlinkedPartConfigsRecordCuid2LinkedPartConfigV2undefined...5more...optionsSkuOptionSpecundefined": { "type": "object", "properties": { "sku": { "type": "string", "description": "External SKU code/name" }, "quantity": { "type": "number", "minimum": 1, "maximum": 500, "description": "Number of complete SKU units to build\n\nThis value is multiplied by the quantity configured on each linked part, respecting any quantity overrides defined in linkedPartConfigs." }, "linkedPartConfigs": { "$ref": "#/components/schemas/RecordCuid2LinkedPartConfigV2", "description": "Configuration overrides for specific parts within this SKU (partId -> config)" }, "tags": { "$ref": "#/components/schemas/Tags", "description": "Tags to categorize or filter this SKU" }, "priority": { "oneOf": [ { "const": 100 }, { "const": 1000 } ], "description": "Priority level for all parts in this SKU build" }, "position": { "oneOf": [ { "const": "front" }, { "const": "back" } ], "description": "Position in the queue: 'front' places jobs at front of priority tier, 'back' at end" }, "skuInstanceStart": { "type": "number", "minimum": 1, "description": "Starting SKU instance number for tracking (1-based)\nUsed internally for order reconciliation" }, "order": { "$ref": "#/components/schemas/OmitOrderInfoV2linkedPartId", "description": "Order information for tracking this SKU build to an order" }, "options": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "value": { "type": "string" } }, "required": [ "id", "value" ] }, { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "string" } }, "required": [ "name", "value" ] } ] }, "description": "SKU options selected for this build\nArray of option selections that can reference options by ID or name\nThese will be converted to selectedOptions format (optionId -> value name)" } }, "required": [ "sku" ] }, "BuildPreviewV2": { "type": "object", "properties": { "partBuilds": { "type": "array", "items": { "$ref": "#/components/schemas/BuildPreviewPartBuildV2" }, "description": "Previewed part builds grouped with their corresponding jobs" }, "summary": { "type": "object", "properties": { "partBuildCount": { "type": "number" }, "skuBuildCount": { "type": "number" }, "jobCount": { "type": "number" } }, "required": [ "partBuildCount", "skuBuildCount", "jobCount" ], "description": "Summary counts for quick display" } }, "required": [ "partBuilds", "summary" ], "description": "Dry-run preview for a v2 build request." }, "BuildPreviewPartBuildV2": { "type": "object", "properties": { "source": { "oneOf": [ { "const": "sku" }, { "const": "part" } ], "description": "Indicates whether this part build comes from direct part config or a SKU config" }, "partId": { "type": "string", "pattern": "^[a-z0-9]{24}$", "description": "Part ID for this previewed part build" }, "partName": { "type": "string", "description": "Part name" }, "partThumbnailUri": { "oneOf": [ { "type": "null" }, { "type": "string" } ], "description": "Optional part-level thumbnail URI" }, "label": { "type": "string", "description": "Label that the part build will use" }, "quantity": { "type": "number", "description": "Part build quantity" }, "sku": { "oneOf": [ { "type": "null" }, { "type": "object", "properties": { "skuId": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "sku": { "type": "string" } }, "required": [ "skuId", "sku" ] } ], "description": "SKU metadata when source is \"sku\"" }, "materials": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/RecordnumberArraySingleMaterialSpecification" } ], "description": "Material assignments that will be used for this part build" }, "plateQuantities": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/Recordstringnumber" } ], "description": "3MF plate quantities, if applicable" }, "jobs": { "type": "array", "items": { "$ref": "#/components/schemas/BuildPreviewJobV2" }, "description": "Print jobs that would be created for this part build" } }, "required": [ "source", "partId", "partName", "label", "quantity", "jobs" ], "description": "Preview of a part build and its resulting jobs." }, "Recordstringnumber": { "type": "object", "properties": {}, "description": "Construct a type with a set of properties K of type T", "additionalProperties": { "type": "number" } }, "BuildPreviewJobV2": { "type": "object", "properties": { "label": { "type": "string", "description": "Label that the print job will use in queue" }, "quantityIndex": { "type": "number", "description": "1-based index of this job within the part build" }, "quantityTotal": { "type": "number", "description": "Total jobs that would be created for this part build" }, "plateId": { "oneOf": [ { "type": "null" }, { "type": "string" }, { "type": "number" } ], "description": "Optional plate ID for 3MF/GCODE 3MF jobs" }, "plateName": { "oneOf": [ { "type": "null" }, { "type": "string" } ], "description": "Optional plate name for 3MF/GCODE 3MF jobs" }, "thumbnailUri": { "oneOf": [ { "type": "null" }, { "type": "string" } ], "description": "Optional thumbnail URI for this job" } }, "required": [ "label", "quantityIndex", "quantityTotal" ], "description": "Preview of a single print job that would be created." }, "PartBuildWithRelation": { "type": "object", "properties": { "partId": { "oneOf": [ { "type": "null" }, { "type": "string", "pattern": "^[a-z0-9]{24}$" } ] }, "skuBuildId": { "oneOf": [ { "type": "null" }, { "type": "string", "pattern": "^[a-z0-9]{24}$" } ] }, "skuId": { "oneOf": [ { "type": "null" }, { "type": "string", "pattern": "^[a-z0-9]{24}$" } ] }, "skuName": { "oneOf": [ { "type": "null" }, { "type": "string", "minLength": 1, "maxLength": 1024 } ] }, "label": { "oneOf": [ { "type": "null" }, { "type": "string", "minLength": 1, "maxLength": 1024 } ] }, "partCopy": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 1024 }, "type": { "oneOf": [ { "const": "scad" }, { "const": "cadquery" }, { "const": "build123d" }, { "const": "stl" }, { "const": "step" }, { "const": "3mf" }, { "const": "gcode3mf" }, { "const": "gcode" } ] }, "description": { "type": "string", "default": "" }, "fileUris": { "type": "array", "items": { "type": "string" } }, "fileHashes": { "type": "array", "items": { "type": "string" } }, "thumbnailUri": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "parameters": { "type": "array", "items": { "type": "object", "properties": { "default": { "oneOf": [ { "type": "number" }, { "type": "string", "minLength": 0, "maxLength": 255 }, { "type": "boolean" } ] }, "options": { "type": "array", "items": { "type": "object", "properties": { "value": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "label": { "type": "string" } }, "required": [ "value" ] } }, "description": { "type": "string" }, "min": { "type": "number" }, "max": { "type": "number" }, "step": { "type": "number" }, "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "type": { "oneOf": [ { "const": "number" }, { "const": "string" }, { "const": "boolean" } ] }, "value": { "oneOf": [ { "type": "number" }, { "type": "string", "minLength": 0, "maxLength": 255 }, { "type": "boolean" } ] } }, "required": [ "name", "type" ] } }, "printTags": { "type": "object", "properties": { "printer.provider": { "type": "string", "minLength": 1 }, "printer.id": { "type": "string", "minLength": 1 }, "printer.nozzleDiameter": { "type": "string", "minLength": 1 }, "printer.modelName": { "type": "string", "minLength": 1 }, "filament.type": { "type": "string", "minLength": 1 }, "user.tags": { "type": "string", "minLength": 1 } } }, "overriddenProcessProfileId": { "oneOf": [ { "type": "null" }, { "type": "string", "pattern": "^[a-z0-9]{24}$" } ] }, "folderId": { "oneOf": [ { "type": "null" }, { "type": "string", "pattern": "^[a-z0-9]{24}$" } ] }, "materials": { "oneOf": [ { "type": "null" }, { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "number", "minimum": 0 }, "color": { "oneOf": [ { "type": "null" }, { "type": "string", "pattern": "^#{0,1}[0-9A-F]{6}|[0-9A-F]{8}$" } ] }, "type": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "skip": { "type": "boolean" }, "name": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "identifier": { "oneOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": [ "index", "color", "type" ] } } ] }, "slicerOverride": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "metadata": { "oneOf": [ { "type": "null" }, { "type": "object", "properties": { "printerModel": { "type": "string" }, "filamentType": { "type": "array", "items": { "type": "string" } }, "filamentColors": { "type": "array", "items": { "type": "string" } }, "filamentDensities": { "type": "array", "items": { "type": "number" } }, "filamentDiameters": { "type": "array", "items": { "type": "number" } }, "nozzleDiameter": { "type": "string" }, "profileCompat": { "type": "object", "properties": { "sliced": { "type": "string" }, "compatible": { "type": "array", "items": { "type": "string" } }, "safe": { "type": "array", "items": { "type": "string" } } }, "required": [ "sliced", "compatible", "safe" ] }, "slicerVersion": { "oneOf": [ { "type": "null" }, { "type": "object", "properties": { "engine": { "oneOf": [ { "const": "orcaslicer" }, { "const": "bambu-studio" }, { "const": "prusaslicer" }, { "const": "superslicer" } ] }, "version": { "type": "string" } }, "required": [ "engine", "version" ] } ] }, "plates": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "locked": { "type": "boolean" }, "filamentMapMode": { "type": "string" }, "filamentMaps": { "type": "array", "items": { "type": "number" } }, "gcodeFile": { "type": "string" }, "thumbnailFile": { "type": "string" }, "thumbnailUploadedUri": { "type": "string" }, "thumbnailNoLightFile": { "type": "string" }, "thumbnailData": { "type": "string" }, "topFile": { "type": "string" }, "pickFile": { "type": "string" }, "topData": { "type": "string", "title": "Base64 PNG data for the top/pick images, staged before upload then cleared", "description": "Base64 PNG data for the top/pick images, staged before upload then cleared." }, "pickData": { "type": "string" }, "topUploadedUri": { "type": "string", "title": "Uploaded URIs for the plate's top-down image and color-coded object pick mask", "description": "Uploaded URIs for the plate's top-down image and color-coded object pick mask.\nUsed by the visual skip-objects picker." }, "pickUploadedUri": { "type": "string" }, "patternBboxFile": { "type": "string" }, "sliced": { "type": "object", "properties": { "index": { "type": "number" }, "extruderType": { "type": "string" }, "nozzleVolumeType": { "type": "string" }, "printerModelId": { "type": "string" }, "nozzleDiameters": { "type": "string" }, "timelapseType": { "type": "string" }, "prediction": { "type": "number" }, "weight": { "type": "number" }, "outside": { "type": "boolean" }, "supportUsed": { "type": "boolean" }, "labelObjectEnabled": { "type": "boolean" }, "filamentMaps": { "type": "string" }, "objects": { "type": "array", "items": { "type": "object", "properties": { "identifyId": { "type": "string" }, "name": { "type": "string" }, "skipped": { "type": "boolean" } }, "required": [ "identifyId", "name", "skipped" ] } }, "filaments": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "trayInfoIdx": { "type": "string" }, "type": { "type": "string" }, "color": { "type": "string" }, "usedM": { "type": "number" }, "usedG": { "type": "number" } }, "required": [ "id", "trayInfoIdx", "type", "color", "usedM", "usedG" ] } }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "msg": { "type": "string" }, "level": { "type": "number" }, "errorCode": { "type": "string" } }, "required": [ "msg", "level", "errorCode" ] } }, "layerFilamentLists": { "type": "array", "items": { "type": "object", "properties": { "filamentList": { "type": "number" }, "layerRanges": { "type": "string" } }, "required": [ "filamentList", "layerRanges" ] } } } }, "filamentIds": { "type": "array", "items": { "type": "string" } } }, "required": [ "id" ] } }, "filamentIds": { "type": "array", "items": { "type": "string" } } }, "required": [ "printerModel", "filamentType", "filamentColors", "nozzleDiameter", "profileCompat" ] } ] }, "slicingEstimate": { "oneOf": [ { "type": "null" }, { "type": "object", "properties": { "estimatedPrintTimeSeconds": { "type": "number" }, "materials": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "number" }, "usedGrams": { "type": "number" }, "usedMeters": { "type": "number" }, "materialType": { "type": "string" }, "color": { "type": "string" } }, "required": [ "index", "usedGrams", "usedMeters", "materialType" ] } }, "totalWeightGrams": { "type": "number" }, "profiles": { "type": "object", "properties": { "machineProfileId": { "type": "string" }, "machineProfileName": { "type": "string" }, "processProfileId": { "type": "string" }, "processProfileName": { "type": "string" }, "filamentProfileIds": { "type": "array", "items": { "type": "string" } }, "filamentProfileNames": { "type": "array", "items": { "type": "string" } } }, "required": [ "machineProfileId", "machineProfileName", "processProfileId", "processProfileName", "filamentProfileIds", "filamentProfileNames" ] }, "slicedAt": { "type": "string" }, "slicerVersion": { "type": "string" }, "plates": { "type": "array", "items": { "type": "object", "properties": { "plateId": { "type": "number" }, "estimatedPrintTimeSeconds": { "type": "number" }, "materials": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "number" }, "usedGrams": { "type": "number" }, "usedMeters": { "type": "number" }, "materialType": { "type": "string" }, "color": { "type": "string" } }, "required": [ "index", "usedGrams", "usedMeters", "materialType" ] } }, "totalWeightGrams": { "type": "number" } }, "required": [ "plateId", "estimatedPrintTimeSeconds", "materials", "totalWeightGrams" ] } } }, "required": [ "estimatedPrintTimeSeconds", "materials", "totalWeightGrams", "slicedAt", "slicerVersion" ] } ] }, "use3MFProcessProfile": { "type": "boolean" }, "arrangeable": { "type": "boolean" }, "userTags": { "type": "array", "items": { "type": "string" } }, "gcodePlateUris": { "oneOf": [ { "type": "null" }, { "type": "object", "properties": {}, "additionalProperties": { "type": "string" } } ] }, "uploadedAt": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "id": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "storeId": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "name", "type", "description", "fileUris", "fileHashes", "thumbnailUri", "parameters", "printTags", "overriddenProcessProfileId", "materials", "id", "storeId", "createdAt", "updatedAt" ] }, "requiredPrinterTags": { "$ref": "#/components/schemas/Tags" }, "quantity": { "type": "number", "minimum": 0, "maximum": 500 }, "numPartsPerSku": { "oneOf": [ { "type": "null" }, { "type": "number" } ] }, "skuInstanceStart": { "oneOf": [ { "type": "null" }, { "type": "number" } ] }, "parameterOverrides": { "type": "array", "items": { "$ref": "#/components/schemas/PartParameterOverride" } }, "status": { "oneOf": [ { "const": "pending" }, { "const": "building" }, { "const": "queued" }, { "const": "fulfilling" }, { "const": "preparing" }, { "const": "sending-to-printer" }, { "const": "printing" }, { "const": "success" }, { "const": "error" }, { "const": "cancelled" } ] }, "outputFiles": { "oneOf": [ { "type": "null" }, { "type": "array", "items": { "type": "string" } } ] }, "thumbnailUri": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "assignmentStartedAt": { "oneOf": [ { "type": "null" }, { "type": "string", "format": "date-time" } ] }, "assignmentCompletedAt": { "oneOf": [ { "type": "null" }, { "type": "string", "format": "date-time" } ] }, "printingStartedAt": { "oneOf": [ { "type": "null" }, { "type": "string", "format": "date-time" } ] }, "printingCompletedAt": { "oneOf": [ { "type": "null" }, { "type": "string", "format": "date-time" } ] }, "printStatus": { "oneOf": [ { "const": "pending" }, { "const": "printing" }, { "const": "success" }, { "const": "error" }, { "const": "cancelled" } ] }, "extensions": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/PartBuildExtensions" } ] }, "materialAssignments": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/MaterialAssignments" } ] }, "priority": { "oneOf": [ { "const": 100 }, { "const": 1000 } ] }, "position": { "oneOf": [ { "const": "front" }, { "const": "back" } ] }, "orderId": { "oneOf": [ { "type": "null" }, { "type": "string", "pattern": "^[a-z0-9]{24}$" } ] }, "orderItemId": { "oneOf": [ { "type": "null" }, { "type": "string", "pattern": "^[a-z0-9]{24}$" } ] }, "linkedPartId": { "oneOf": [ { "type": "null" }, { "type": "string", "pattern": "^[a-z0-9]{24}$" } ] }, "dismissed": { "type": "boolean" }, "id": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "storeId": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "steps": { "type": "array", "items": { "$ref": "#/components/schemas/PartBuildStep" } }, "printJobs": { "type": "array", "items": { "$ref": "#/components/schemas/PrintJob" } } }, "required": [ "partId", "skuBuildId", "skuId", "skuName", "label", "partCopy", "requiredPrinterTags", "quantity", "parameterOverrides", "status", "outputFiles", "thumbnailUri", "assignmentStartedAt", "assignmentCompletedAt", "printingStartedAt", "printingCompletedAt", "printStatus", "materialAssignments", "priority", "position", "orderId", "orderItemId", "linkedPartId", "dismissed", "id", "storeId", "createdAt", "updatedAt", "steps", "printJobs" ] }, "PartBuildStep": { "type": "object", "properties": { "partBuildId": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "order": { "type": "number", "minimum": 0 }, "builder": { "oneOf": [ { "const": "slic3r" }, { "const": "openscad" }, { "const": "cadquery" } ] }, "inputFiles": { "type": "array", "items": { "type": "string" }, "minItems": 1 }, "inputParameters": { "oneOf": [ { "$ref": "#/components/schemas/OpenSCADInputParameters" }, { "$ref": "#/components/schemas/CadQueryInputParameters" } ] }, "inputHash": { "oneOf": [ { "type": "null" }, { "type": "string", "minLength": 1 } ] }, "cachedBuildStepId": { "oneOf": [ { "type": "null" }, { "type": "string", "pattern": "^[a-z0-9]{24}$" } ] }, "cachedOutputFile": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "outputFiles": { "type": "array", "items": { "type": "string" }, "minItems": 1 }, "status": { "oneOf": [ { "const": "pending" }, { "const": "running" }, { "const": "success" }, { "const": "error" }, { "const": "cancelled" }, { "const": "cached" }, { "const": "force_running" } ] }, "logs": { "type": "array", "items": { "type": "string" } }, "requiresAssignedPrinter": { "type": "boolean" }, "nextStepId": { "oneOf": [ { "type": "null" }, { "type": "string", "pattern": "^[a-z0-9]{24}$" } ] }, "startedAt": { "oneOf": [ { "type": "null" }, { "type": "string", "format": "date-time" } ] }, "completedAt": { "oneOf": [ { "type": "null" }, { "type": "string", "format": "date-time" } ] }, "dismissed": { "type": "boolean" }, "id": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "storeId": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "partBuildId", "order", "builder", "inputFiles", "inputHash", "cachedBuildStepId", "cachedOutputFile", "outputFiles", "status", "logs", "requiresAssignedPrinter", "nextStepId", "startedAt", "completedAt", "dismissed", "id", "storeId", "createdAt", "updatedAt" ] }, "OpenSCADInputParameters": { "type": "object", "properties": { "buildVariables": { "type": "array", "items": { "type": "string" } }, "colors": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "number" }, "color": { "type": "string" }, "type": { "oneOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": [ "index", "color", "type" ] } } } }, "CadQueryInputParameters": { "type": "object", "properties": { "params": { "$ref": "#/components/schemas/Recordstringany" } } }, "partIdstringundefinedskuBuildIdstringundefinedskuIdstringundefinedskuNamestringundefinedlabelstringundefinedpartCopystringundefined...24more...updatedAtstringundefinedQuerySettings...": { "type": "object", "properties": { "partId": { "type": "string" }, "skuBuildId": { "type": "string" }, "skuId": { "type": "string" }, "skuName": { "type": "string" }, "label": { "type": "string" }, "partCopy": { "type": "string" }, "requiredPrinterTags": { "type": "string" }, "quantity": { "type": "string" }, "numPartsPerSku": { "type": "string" }, "skuInstanceStart": { "type": "string" }, "parameterOverrides": { "type": "string" }, "status": { "type": "string" }, "outputFiles": { "type": "string" }, "thumbnailUri": { "type": "string" }, "assignmentStartedAt": { "type": "string" }, "assignmentCompletedAt": { "type": "string" }, "printingStartedAt": { "type": "string" }, "printingCompletedAt": { "type": "string" }, "printStatus": { "type": "string" }, "extensions": { "type": "string" }, "materialAssignments": { "type": "string" }, "priority": { "type": "string" }, "position": { "type": "string" }, "orderId": { "type": "string" }, "orderItemId": { "type": "string" }, "linkedPartId": { "type": "string" }, "dismissed": { "type": "string" }, "id": { "type": "string" }, "storeId": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "sort": { "type": "string", "title": "Sort", "description": "Sort specification in format \"field:asc,field2:desc\"" }, "limit": { "type": "number", "minimum": 1, "maximum": 1000, "title": "Limit", "description": "Maximum number of results to return (default: 100, max: 1000)" }, "offset": { "type": "number", "minimum": 0, "title": "Offset", "description": "Number of results to skip for pagination" }, "fields": { "type": "string", "title": "Fields", "description": "Comma-separated list of fields to return" }, "include": { "type": "string", "title": "Include", "description": "Comma-separated list of relations to include (max 4, max 2 levels deep).\nExample: \"linkedParts,linkedParts.part,folder\"" }, "meta": { "type": "boolean", "title": "Meta", "description": "If true, returns response with metadata (total, count, hasMore, etc.)" }, "hints": { "type": "boolean", "title": "Hints", "description": "If true, returns AI-friendly hints about available actions. Implies meta=true." } } }, "SearchQueryDtoPartBuild": { "type": "object", "properties": { "filter": { "oneOf": [ { "$ref": "#/components/schemas/LogicalConditionPartBuild" }, { "$ref": "#/components/schemas/FieldConditionPartBuild" } ], "title": "Filter", "description": "Complex filter conditions using logical and field operators.\nAvailable field operators: eq, ne, gt, gte, lt, lte, contains, startsWith, endsWith, in, notIn, isNull, between.\nUsage example: {\"filter\": {\"and\": [{\"name\": {\"contains\": \"benchy\"}}, {\"or\": [{\"type\": {\"eq\": \"3mf\"}}, {\"type\": {\"eq\": \"gcode3mf\"}}]}}}" }, "sort": { "type": "string", "title": "Sort", "description": "Sort specification in format \"field:asc,field2:desc\"" }, "limit": { "type": "number", "minimum": 1, "maximum": 1000, "title": "Limit", "description": "Maximum number of results to return (default: 100, max: 1000)" }, "offset": { "type": "number", "minimum": 0, "title": "Offset", "description": "Number of results to skip for pagination" }, "fields": { "type": "string", "title": "Fields", "description": "Comma-separated list of fields to return" }, "include": { "type": "string", "title": "Include", "description": "Comma-separated list of relations to include (max 4, max 2 levels deep).\nExample: \"linkedParts,linkedParts.part,folder\"" }, "meta": { "type": "boolean", "title": "Meta", "description": "If true, returns response with metadata (total, count, hasMore, etc.)" }, "hints": { "type": "boolean", "title": "Hints", "description": "If true, returns AI-friendly hints about available actions. Implies meta=true." } }, "title": "Search Query", "description": "Complete search request with filter conditions and query settings" }, "LogicalConditionPartBuild": { "type": "object", "properties": { "and": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/LogicalConditionPartBuild" }, { "$ref": "#/components/schemas/FieldConditionPartBuild" } ] }, "title": "AND Conditions", "description": "All conditions must be true" }, "or": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/LogicalConditionPartBuild" }, { "$ref": "#/components/schemas/FieldConditionPartBuild" } ] }, "title": "OR Conditions", "description": "At least one condition must be true" } }, "title": "Logical Condition", "description": "Logical operators for combining multiple filter conditions" }, "FieldConditionPartBuild": { "type": "object", "properties": { "partId": { "$ref": "#/components/schemas/FieldOperators" }, "skuBuildId": { "$ref": "#/components/schemas/FieldOperators" }, "skuId": { "$ref": "#/components/schemas/FieldOperators" }, "skuName": { "$ref": "#/components/schemas/FieldOperators" }, "label": { "$ref": "#/components/schemas/FieldOperators" }, "partCopy": { "$ref": "#/components/schemas/FieldOperators" }, "requiredPrinterTags": { "$ref": "#/components/schemas/FieldOperators" }, "quantity": { "$ref": "#/components/schemas/FieldOperators" }, "numPartsPerSku": { "$ref": "#/components/schemas/FieldOperators" }, "skuInstanceStart": { "$ref": "#/components/schemas/FieldOperators" }, "parameterOverrides": { "$ref": "#/components/schemas/FieldOperators" }, "status": { "$ref": "#/components/schemas/FieldOperators" }, "outputFiles": { "$ref": "#/components/schemas/FieldOperators" }, "thumbnailUri": { "$ref": "#/components/schemas/FieldOperators" }, "assignmentStartedAt": { "$ref": "#/components/schemas/FieldOperators" }, "assignmentCompletedAt": { "$ref": "#/components/schemas/FieldOperators" }, "printingStartedAt": { "$ref": "#/components/schemas/FieldOperators" }, "printingCompletedAt": { "$ref": "#/components/schemas/FieldOperators" }, "printStatus": { "$ref": "#/components/schemas/FieldOperators" }, "extensions": { "$ref": "#/components/schemas/FieldOperators" }, "materialAssignments": { "$ref": "#/components/schemas/FieldOperators" }, "priority": { "$ref": "#/components/schemas/FieldOperators" }, "position": { "$ref": "#/components/schemas/FieldOperators" }, "orderId": { "$ref": "#/components/schemas/FieldOperators" }, "orderItemId": { "$ref": "#/components/schemas/FieldOperators" }, "linkedPartId": { "$ref": "#/components/schemas/FieldOperators" }, "dismissed": { "$ref": "#/components/schemas/FieldOperators" }, "id": { "$ref": "#/components/schemas/FieldOperators" }, "storeId": { "$ref": "#/components/schemas/FieldOperators" }, "createdAt": { "$ref": "#/components/schemas/FieldOperators" }, "updatedAt": { "$ref": "#/components/schemas/FieldOperators" } }, "title": "Field Condition", "description": "Field-based filter conditions where keys are field names and values are field operators" }, "PartBuildOperationRequest": { "type": "object", "properties": { "partBuildIds": { "type": "array", "items": { "type": "string" } } }, "required": [ "partBuildIds" ] }, "GetUsersResponse": { "type": "object", "properties": { "users": { "type": "array", "items": { "$ref": "#/components/schemas/UserSummary" } }, "total": { "type": "number" } }, "required": [ "users", "total" ] }, "UserSummary": { "type": "object", "properties": { "userId": { "type": "string" }, "email": { "type": "string" }, "displayName": { "type": "string" }, "isOwner": { "type": "boolean" }, "roles": { "type": "array", "items": { "type": "string" }, "title": "Role identifiers (usually system role keys like \"operator\", or role IDs for custom roles)", "description": "Role identifiers (usually system role keys like \"operator\", or role IDs for custom roles)." }, "permissions": { "type": "array", "items": { "oneOf": [ { "const": "organization.owner" }, { "const": "organization.edit" }, { "const": "organization.delete" }, { "const": "user.view" }, { "const": "user.invite" }, { "const": "user.edit" }, { "const": "user.delete" }, { "const": "permission.view" }, { "const": "permission.grant" }, { "const": "permission.revoke" }, { "const": "part.view" }, { "const": "part.create" }, { "const": "part.edit" }, { "const": "part.delete" }, { "const": "part.export" }, { "const": "sku.view" }, { "const": "sku.create" }, { "const": "sku.edit" }, { "const": "sku.delete" }, { "const": "material.view" }, { "const": "material.create" }, { "const": "material.edit" }, { "const": "material.delete" }, { "const": "material.instance.view" }, { "const": "material.instance.create" }, { "const": "material.instance.edit" }, { "const": "material.instance.delete" }, { "const": "printer.view" }, { "const": "printer.create" }, { "const": "printer.edit" }, { "const": "printer.delete" }, { "const": "printer.control" }, { "const": "printer.ready" }, { "const": "printer.config" }, { "const": "printer.stats" }, { "const": "printer.camera" }, { "const": "profile.view" }, { "const": "profile.create" }, { "const": "profile.edit" }, { "const": "profile.delete" }, { "const": "queue.view" }, { "const": "queue.manage" }, { "const": "queue.override" }, { "const": "job.create" }, { "const": "job.edit.own" }, { "const": "job.edit.all" }, { "const": "job.delete.own" }, { "const": "job.delete.all" }, { "const": "build.view" }, { "const": "build.create" }, { "const": "build.edit" }, { "const": "build.delete" }, { "const": "settings.view" }, { "const": "settings.edit" }, { "const": "integration.view" }, { "const": "integration.manage" }, { "const": "subscription.view" }, { "const": "subscription.manage" }, { "const": "analytics.view" }, { "const": "reports.generate" }, { "const": "audit.log.view" }, { "const": "audit.logs.configure" }, { "const": "order.view" }, { "const": "order.create" }, { "const": "order.edit" }, { "const": "order.delete" }, { "const": "order.print" }, { "const": "apiKey.view" }, { "const": "apiKey.create" }, { "const": "apiKey.edit" }, { "const": "apiKey.delete" }, { "const": "file.download" }, { "const": "maintenance.view" }, { "const": "maintenance.create" }, { "const": "maintenance.edit" }, { "const": "maintenance.delete" }, { "const": "maintenance.complete" }, { "const": "internal.shopify" }, { "const": "queue.admin" }, { "const": "part.viewer" }, { "const": "part.editor" }, { "const": "sku.viewer" }, { "const": "sku.editor" }, { "const": "orders.admin" }, { "const": "material.viewer" }, { "const": "material.editor" }, { "const": "printer.viewer" }, { "const": "printer.editor" }, { "const": "profile.viewer" }, { "const": "profile.editor" }, { "const": "settings.admin" }, { "const": "subscription.admin" } ] } }, "lastActive": { "type": "string", "format": "date-time" }, "status": { "oneOf": [ { "const": "active" }, { "const": "inactive" }, { "const": "invited" }, { "const": "expired" } ] }, "createdAt": { "type": "string", "format": "date-time" }, "invitationId": { "type": "string", "title": "Present only for invited/expired rows", "description": "Present only for invited/expired rows." }, "expiresAt": { "type": "string", "title": "Invitation expiry date (invited/expired rows only)", "description": "Invitation expiry date (invited/expired rows only).", "format": "date-time" }, "invitedByEmail": { "type": "string", "title": "Email of the person who sent the invitation", "description": "Email of the person who sent the invitation." } }, "required": [ "email", "isOwner", "roles", "permissions", "status", "createdAt" ] }, "UserDetails": { "type": "object", "properties": { "activityLog": { "type": "array", "items": { "$ref": "#/components/schemas/ActivityLogEntry" } }, "userId": { "type": "string" }, "email": { "type": "string" }, "displayName": { "type": "string" }, "isOwner": { "type": "boolean" }, "roles": { "type": "array", "items": { "type": "string" }, "title": "Role identifiers (usually system role keys like \"operator\", or role IDs for custom roles)", "description": "Role identifiers (usually system role keys like \"operator\", or role IDs for custom roles)." }, "permissions": { "type": "array", "items": { "oneOf": [ { "const": "organization.owner" }, { "const": "organization.edit" }, { "const": "organization.delete" }, { "const": "user.view" }, { "const": "user.invite" }, { "const": "user.edit" }, { "const": "user.delete" }, { "const": "permission.view" }, { "const": "permission.grant" }, { "const": "permission.revoke" }, { "const": "part.view" }, { "const": "part.create" }, { "const": "part.edit" }, { "const": "part.delete" }, { "const": "part.export" }, { "const": "sku.view" }, { "const": "sku.create" }, { "const": "sku.edit" }, { "const": "sku.delete" }, { "const": "material.view" }, { "const": "material.create" }, { "const": "material.edit" }, { "const": "material.delete" }, { "const": "material.instance.view" }, { "const": "material.instance.create" }, { "const": "material.instance.edit" }, { "const": "material.instance.delete" }, { "const": "printer.view" }, { "const": "printer.create" }, { "const": "printer.edit" }, { "const": "printer.delete" }, { "const": "printer.control" }, { "const": "printer.ready" }, { "const": "printer.config" }, { "const": "printer.stats" }, { "const": "printer.camera" }, { "const": "profile.view" }, { "const": "profile.create" }, { "const": "profile.edit" }, { "const": "profile.delete" }, { "const": "queue.view" }, { "const": "queue.manage" }, { "const": "queue.override" }, { "const": "job.create" }, { "const": "job.edit.own" }, { "const": "job.edit.all" }, { "const": "job.delete.own" }, { "const": "job.delete.all" }, { "const": "build.view" }, { "const": "build.create" }, { "const": "build.edit" }, { "const": "build.delete" }, { "const": "settings.view" }, { "const": "settings.edit" }, { "const": "integration.view" }, { "const": "integration.manage" }, { "const": "subscription.view" }, { "const": "subscription.manage" }, { "const": "analytics.view" }, { "const": "reports.generate" }, { "const": "audit.log.view" }, { "const": "audit.logs.configure" }, { "const": "order.view" }, { "const": "order.create" }, { "const": "order.edit" }, { "const": "order.delete" }, { "const": "order.print" }, { "const": "apiKey.view" }, { "const": "apiKey.create" }, { "const": "apiKey.edit" }, { "const": "apiKey.delete" }, { "const": "file.download" }, { "const": "maintenance.view" }, { "const": "maintenance.create" }, { "const": "maintenance.edit" }, { "const": "maintenance.delete" }, { "const": "maintenance.complete" }, { "const": "internal.shopify" }, { "const": "queue.admin" }, { "const": "part.viewer" }, { "const": "part.editor" }, { "const": "sku.viewer" }, { "const": "sku.editor" }, { "const": "orders.admin" }, { "const": "material.viewer" }, { "const": "material.editor" }, { "const": "printer.viewer" }, { "const": "printer.editor" }, { "const": "profile.viewer" }, { "const": "profile.editor" }, { "const": "settings.admin" }, { "const": "subscription.admin" } ] } }, "lastActive": { "type": "string", "format": "date-time" }, "status": { "oneOf": [ { "const": "active" }, { "const": "inactive" }, { "const": "invited" }, { "const": "expired" } ] }, "createdAt": { "type": "string", "format": "date-time" }, "invitationId": { "type": "string", "title": "Present only for invited/expired rows", "description": "Present only for invited/expired rows." }, "expiresAt": { "type": "string", "title": "Invitation expiry date (invited/expired rows only)", "description": "Invitation expiry date (invited/expired rows only).", "format": "date-time" }, "invitedByEmail": { "type": "string", "title": "Email of the person who sent the invitation", "description": "Email of the person who sent the invitation." } }, "required": [ "activityLog", "email", "isOwner", "roles", "permissions", "status", "createdAt" ] }, "ActivityLogEntry": { "type": "object", "properties": { "id": { "type": "string" }, "action": { "type": "string" }, "timestamp": { "type": "string", "format": "date-time" }, "details": { "type": "string" } }, "required": [ "id", "action", "timestamp" ] }, "InviteUserResponse": { "type": "object", "properties": { "invitationId": { "type": "string" }, "email": { "type": "string" }, "expiresAt": { "type": "string", "format": "date-time" } }, "required": [ "invitationId", "email", "expiresAt" ] }, "InviteUserRequest": { "type": "object", "properties": { "email": { "type": "string", "format": "email" }, "roleId": { "type": "string" }, "permissions": { "type": "array", "items": { "oneOf": [ { "const": "organization.owner" }, { "const": "organization.edit" }, { "const": "organization.delete" }, { "const": "user.view" }, { "const": "user.invite" }, { "const": "user.edit" }, { "const": "user.delete" }, { "const": "permission.view" }, { "const": "permission.grant" }, { "const": "permission.revoke" }, { "const": "part.view" }, { "const": "part.create" }, { "const": "part.edit" }, { "const": "part.delete" }, { "const": "part.export" }, { "const": "sku.view" }, { "const": "sku.create" }, { "const": "sku.edit" }, { "const": "sku.delete" }, { "const": "material.view" }, { "const": "material.create" }, { "const": "material.edit" }, { "const": "material.delete" }, { "const": "material.instance.view" }, { "const": "material.instance.create" }, { "const": "material.instance.edit" }, { "const": "material.instance.delete" }, { "const": "printer.view" }, { "const": "printer.create" }, { "const": "printer.edit" }, { "const": "printer.delete" }, { "const": "printer.control" }, { "const": "printer.ready" }, { "const": "printer.config" }, { "const": "printer.stats" }, { "const": "printer.camera" }, { "const": "profile.view" }, { "const": "profile.create" }, { "const": "profile.edit" }, { "const": "profile.delete" }, { "const": "queue.view" }, { "const": "queue.manage" }, { "const": "queue.override" }, { "const": "job.create" }, { "const": "job.edit.own" }, { "const": "job.edit.all" }, { "const": "job.delete.own" }, { "const": "job.delete.all" }, { "const": "build.view" }, { "const": "build.create" }, { "const": "build.edit" }, { "const": "build.delete" }, { "const": "settings.view" }, { "const": "settings.edit" }, { "const": "integration.view" }, { "const": "integration.manage" }, { "const": "subscription.view" }, { "const": "subscription.manage" }, { "const": "analytics.view" }, { "const": "reports.generate" }, { "const": "audit.log.view" }, { "const": "audit.logs.configure" }, { "const": "order.view" }, { "const": "order.create" }, { "const": "order.edit" }, { "const": "order.delete" }, { "const": "order.print" }, { "const": "apiKey.view" }, { "const": "apiKey.create" }, { "const": "apiKey.edit" }, { "const": "apiKey.delete" }, { "const": "file.download" }, { "const": "maintenance.view" }, { "const": "maintenance.create" }, { "const": "maintenance.edit" }, { "const": "maintenance.delete" }, { "const": "maintenance.complete" }, { "const": "internal.shopify" }, { "const": "queue.admin" }, { "const": "part.viewer" }, { "const": "part.editor" }, { "const": "sku.viewer" }, { "const": "sku.editor" }, { "const": "orders.admin" }, { "const": "material.viewer" }, { "const": "material.editor" }, { "const": "printer.viewer" }, { "const": "printer.editor" }, { "const": "profile.viewer" }, { "const": "profile.editor" }, { "const": "settings.admin" }, { "const": "subscription.admin" } ] } } }, "required": [ "email" ] }, "RemoveUserRequest": { "type": "object", "properties": { "userId": { "type": "string" }, "transferOwnershipTo": { "type": "string" } }, "required": [ "userId" ] }, "BulkUpdateUsersResponse": { "type": "object", "properties": { "succeeded": { "type": "array", "items": { "type": "string" } }, "failed": { "type": "array", "items": { "type": "object", "properties": { "userId": { "type": "string" }, "error": { "type": "string" } }, "required": [ "userId", "error" ] } } }, "required": [ "succeeded", "failed" ] }, "BulkUpdateUsersRequest": { "type": "object", "properties": { "userIds": { "type": "array", "items": { "type": "string" } }, "operation": { "const": "remove" }, "roleId": { "type": "string" }, "permissions": { "type": "array", "items": { "oneOf": [ { "const": "organization.owner" }, { "const": "organization.edit" }, { "const": "organization.delete" }, { "const": "user.view" }, { "const": "user.invite" }, { "const": "user.edit" }, { "const": "user.delete" }, { "const": "permission.view" }, { "const": "permission.grant" }, { "const": "permission.revoke" }, { "const": "part.view" }, { "const": "part.create" }, { "const": "part.edit" }, { "const": "part.delete" }, { "const": "part.export" }, { "const": "sku.view" }, { "const": "sku.create" }, { "const": "sku.edit" }, { "const": "sku.delete" }, { "const": "material.view" }, { "const": "material.create" }, { "const": "material.edit" }, { "const": "material.delete" }, { "const": "material.instance.view" }, { "const": "material.instance.create" }, { "const": "material.instance.edit" }, { "const": "material.instance.delete" }, { "const": "printer.view" }, { "const": "printer.create" }, { "const": "printer.edit" }, { "const": "printer.delete" }, { "const": "printer.control" }, { "const": "printer.ready" }, { "const": "printer.config" }, { "const": "printer.stats" }, { "const": "printer.camera" }, { "const": "profile.view" }, { "const": "profile.create" }, { "const": "profile.edit" }, { "const": "profile.delete" }, { "const": "queue.view" }, { "const": "queue.manage" }, { "const": "queue.override" }, { "const": "job.create" }, { "const": "job.edit.own" }, { "const": "job.edit.all" }, { "const": "job.delete.own" }, { "const": "job.delete.all" }, { "const": "build.view" }, { "const": "build.create" }, { "const": "build.edit" }, { "const": "build.delete" }, { "const": "settings.view" }, { "const": "settings.edit" }, { "const": "integration.view" }, { "const": "integration.manage" }, { "const": "subscription.view" }, { "const": "subscription.manage" }, { "const": "analytics.view" }, { "const": "reports.generate" }, { "const": "audit.log.view" }, { "const": "audit.logs.configure" }, { "const": "order.view" }, { "const": "order.create" }, { "const": "order.edit" }, { "const": "order.delete" }, { "const": "order.print" }, { "const": "apiKey.view" }, { "const": "apiKey.create" }, { "const": "apiKey.edit" }, { "const": "apiKey.delete" }, { "const": "file.download" }, { "const": "maintenance.view" }, { "const": "maintenance.create" }, { "const": "maintenance.edit" }, { "const": "maintenance.delete" }, { "const": "maintenance.complete" }, { "const": "internal.shopify" }, { "const": "queue.admin" }, { "const": "part.viewer" }, { "const": "part.editor" }, { "const": "sku.viewer" }, { "const": "sku.editor" }, { "const": "orders.admin" }, { "const": "material.viewer" }, { "const": "material.editor" }, { "const": "printer.viewer" }, { "const": "printer.editor" }, { "const": "profile.viewer" }, { "const": "profile.editor" }, { "const": "settings.admin" }, { "const": "subscription.admin" } ] } } }, "required": [ "userIds", "operation" ] }, "Integration": { "type": "object", "properties": { "type": { "oneOf": [ { "const": "bambulab" }, { "const": "etsy" }, { "const": "shopify" }, { "const": "ebay" }, { "const": "tiktok-shop" }, { "const": "filametrics" } ] }, "externalId": { "oneOf": [ { "type": "null" }, { "type": "string" } ], "description": "External identifier for deduplication (e.g., shopId for Etsy)" }, "publicData": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/FilametricsPublicData" }, { "$ref": "#/components/schemas/EtsyPublicData" }, { "$ref": "#/components/schemas/ShopifyPublicData" }, { "$ref": "#/components/schemas/BambuLabPublicData" }, { "$ref": "#/components/schemas/EbayPublicData" }, { "$ref": "#/components/schemas/TikTokShopPublicData" } ], "description": "Public metadata safe to expose to frontend" }, "settings": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/EtsySettings" }, { "$ref": "#/components/schemas/ShopifySettings" }, { "$ref": "#/components/schemas/EbaySettings" }, { "$ref": "#/components/schemas/TikTokShopSettings" } ], "description": "User-configurable settings" }, "id": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "storeId": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "type", "id", "storeId", "createdAt", "updatedAt" ] }, "FilametricsPublicData": { "type": "object", "properties": { "connectedAt": { "type": "number" } }, "required": [ "connectedAt" ], "description": "Public data for Filametrics integrations (safe to expose to frontend)" }, "EtsyPublicData": { "type": "object", "properties": { "shopId": { "type": "string" }, "shopName": { "type": "string" }, "shopUrl": { "type": "string" }, "lastSyncedAt": { "type": "number" } }, "required": [ "shopId", "shopName" ], "description": "Public data for Etsy integrations (safe to expose to frontend)" }, "ShopifyPublicData": { "type": "object", "properties": { "shopName": { "type": "string" }, "shopDomain": { "type": "string" }, "lastSyncedAt": { "type": "number" } }, "required": [ "shopName", "shopDomain" ], "description": "Public data for Shopify integrations (safe to expose to frontend)" }, "BambuLabPublicData": { "type": "object", "properties": { "username": { "type": "string" } }, "description": "Public data for BambuLab integrations (safe to expose to frontend)" }, "EbayPublicData": { "type": "object", "properties": { "sellerId": { "type": "string" }, "username": { "type": "string" }, "marketplaceId": { "type": "string", "description": "eBay marketplace ID (e.g., EBAY_US, EBAY_UK, EBAY_DE, EBAY_AU)" }, "lastSyncedAt": { "type": "number" } }, "required": [ "sellerId", "username", "marketplaceId" ], "description": "Public data for eBay integrations (safe to expose to frontend)" }, "TikTokShopPublicData": { "type": "object", "properties": { "shopId": { "type": "string" }, "shopName": { "type": "string" }, "region": { "type": "string", "description": "TikTok Shop region (e.g., US, UK, ID)" }, "lastSyncedAt": { "type": "number" }, "disconnectedAt": { "type": "number", "description": "Set when TikTok notifies us (SELLER_DEAUTHORIZATION webhook) that the seller\nrevoked our app's access. The stored tokens are dead once this is set, so\nsyncs stop and the UI prompts a reconnect. Cleared when the seller\nre-authorizes through OAuth." }, "disconnectReason": { "const": "seller_deauthorized", "title": "Why the integration was auto-disconnected (only `seller_deauthorized` today)", "description": "Why the integration was auto-disconnected (only `seller_deauthorized` today)." } }, "required": [ "shopId", "shopName", "region" ], "description": "Public data for TikTok Shop integrations (safe to expose to frontend)" }, "EtsySettings": { "type": "object", "properties": { "autoPrint": { "type": "boolean" }, "autoCloseOrders": { "oneOf": [ { "const": "shipped" }, { "const": "delivered" }, { "const": "never" } ] }, "ignoredVariantNames": { "type": "array", "items": { "type": "string" }, "description": "Variant option names to exclude from SKU matching (e.g., [\"Size\"])" } }, "description": "Settings for Etsy integrations" }, "ShopifySettings": { "type": "object", "properties": { "autoPrint": { "type": "boolean" }, "writeProgressTags": { "type": "boolean", "title": "Keep Shopify order tags in sync with Printago print job progress (e.g. \"2/5 printed\")", "description": "Keep Shopify order tags in sync with Printago print job progress (e.g. \"2/5 printed\")." }, "autoCloseOrders": { "oneOf": [ { "const": "partial" }, { "const": "never" }, { "const": "fulfilled" } ], "title": "When to automatically close orders in Printago based on Shopify status", "description": "When to automatically close orders in Printago based on Shopify status.\n- 'fulfilled': Close when Shopify order is fully fulfilled (shipped)\n- 'partial': Close when any items are fulfilled\n- 'never': Never auto-close based on fulfillment" }, "tagWhenPrinted": { "type": "string", "description": "Tag to add to orders when fully printed (empty string disables)" }, "propertyWhitelist": { "type": "array", "items": { "type": "string" }, "description": "Property names to import as SKU options (e.g., [\"Logo\", \"Back Color\"])" }, "ignoredVariantNames": { "type": "array", "items": { "type": "string" }, "description": "Variant option names to exclude from SKU matching (e.g., [\"Size\"])" } }, "description": "Settings for Shopify integrations" }, "EbaySettings": { "type": "object", "properties": { "autoPrint": { "type": "boolean" }, "autoCloseOrders": { "oneOf": [ { "const": "shipped" }, { "const": "delivered" }, { "const": "never" } ] } }, "description": "Settings for eBay integrations" }, "TikTokShopSettings": { "type": "object", "properties": { "autoPrint": { "type": "boolean" }, "autoCloseOrders": { "oneOf": [ { "const": "shipped" }, { "const": "delivered" }, { "const": "never" } ] } }, "description": "Settings for TikTok Shop integrations" }, "typestringundefinedexternalIdstringundefinedpublicDatastringundefinedsettingsstringundefinedidstringundefinedstoreIdstringundefinedcreatedAtstringundefinedupdatedAtstringundefinedQuerySettings...": { "type": "object", "properties": { "type": { "type": "string" }, "externalId": { "type": "string", "description": "External identifier for deduplication (e.g., shopId for Etsy)" }, "publicData": { "type": "string", "description": "Public metadata safe to expose to frontend" }, "settings": { "type": "string", "description": "User-configurable settings" }, "id": { "type": "string" }, "storeId": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "sort": { "type": "string", "title": "Sort", "description": "Sort specification in format \"field:asc,field2:desc\"" }, "limit": { "type": "number", "minimum": 1, "maximum": 1000, "title": "Limit", "description": "Maximum number of results to return (default: 100, max: 1000)" }, "offset": { "type": "number", "minimum": 0, "title": "Offset", "description": "Number of results to skip for pagination" }, "fields": { "type": "string", "title": "Fields", "description": "Comma-separated list of fields to return" }, "include": { "type": "string", "title": "Include", "description": "Comma-separated list of relations to include (max 4, max 2 levels deep).\nExample: \"linkedParts,linkedParts.part,folder\"" }, "meta": { "type": "boolean", "title": "Meta", "description": "If true, returns response with metadata (total, count, hasMore, etc.)" }, "hints": { "type": "boolean", "title": "Hints", "description": "If true, returns AI-friendly hints about available actions. Implies meta=true." } } }, "SearchQueryDtoIntegration": { "type": "object", "properties": { "filter": { "oneOf": [ { "$ref": "#/components/schemas/LogicalConditionIntegration" }, { "$ref": "#/components/schemas/FieldConditionIntegration" } ], "title": "Filter", "description": "Complex filter conditions using logical and field operators.\nAvailable field operators: eq, ne, gt, gte, lt, lte, contains, startsWith, endsWith, in, notIn, isNull, between.\nUsage example: {\"filter\": {\"and\": [{\"name\": {\"contains\": \"benchy\"}}, {\"or\": [{\"type\": {\"eq\": \"3mf\"}}, {\"type\": {\"eq\": \"gcode3mf\"}}]}}}" }, "sort": { "type": "string", "title": "Sort", "description": "Sort specification in format \"field:asc,field2:desc\"" }, "limit": { "type": "number", "minimum": 1, "maximum": 1000, "title": "Limit", "description": "Maximum number of results to return (default: 100, max: 1000)" }, "offset": { "type": "number", "minimum": 0, "title": "Offset", "description": "Number of results to skip for pagination" }, "fields": { "type": "string", "title": "Fields", "description": "Comma-separated list of fields to return" }, "include": { "type": "string", "title": "Include", "description": "Comma-separated list of relations to include (max 4, max 2 levels deep).\nExample: \"linkedParts,linkedParts.part,folder\"" }, "meta": { "type": "boolean", "title": "Meta", "description": "If true, returns response with metadata (total, count, hasMore, etc.)" }, "hints": { "type": "boolean", "title": "Hints", "description": "If true, returns AI-friendly hints about available actions. Implies meta=true." } }, "title": "Search Query", "description": "Complete search request with filter conditions and query settings" }, "LogicalConditionIntegration": { "type": "object", "properties": { "and": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/LogicalConditionIntegration" }, { "$ref": "#/components/schemas/FieldConditionIntegration" } ] }, "title": "AND Conditions", "description": "All conditions must be true" }, "or": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/LogicalConditionIntegration" }, { "$ref": "#/components/schemas/FieldConditionIntegration" } ] }, "title": "OR Conditions", "description": "At least one condition must be true" } }, "title": "Logical Condition", "description": "Logical operators for combining multiple filter conditions" }, "FieldConditionIntegration": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/FieldOperators" }, "externalId": { "$ref": "#/components/schemas/FieldOperators", "description": "External identifier for deduplication (e.g., shopId for Etsy)" }, "publicData": { "$ref": "#/components/schemas/FieldOperators", "description": "Public metadata safe to expose to frontend" }, "settings": { "$ref": "#/components/schemas/FieldOperators", "description": "User-configurable settings" }, "id": { "$ref": "#/components/schemas/FieldOperators" }, "storeId": { "$ref": "#/components/schemas/FieldOperators" }, "createdAt": { "$ref": "#/components/schemas/FieldOperators" }, "updatedAt": { "$ref": "#/components/schemas/FieldOperators" } }, "title": "Field Condition", "description": "Field-based filter conditions where keys are field names and values are field operators" }, "SkuBuildWithRelation": { "type": "object", "properties": { "skuId": { "oneOf": [ { "type": "null" }, { "type": "string", "pattern": "^[a-z0-9]{24}$" } ] }, "skuCopy": { "type": "object", "properties": { "sku": { "type": "string", "minLength": 1, "maxLength": 1024 }, "title": { "type": "string" }, "description": { "type": "string" }, "externalId": { "oneOf": [ { "type": "null" }, { "type": "string", "minLength": 1, "maxLength": 1024 } ] }, "externalProvider": { "oneOf": [ { "type": "null" }, { "const": "etsy" }, { "const": "shopify" } ] }, "folderId": { "oneOf": [ { "type": "null" }, { "type": "string", "pattern": "^[a-z0-9]{24}$" } ] }, "totalCogs": { "type": "number" }, "id": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "storeId": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "sku", "title", "description", "externalId", "externalProvider", "totalCogs", "id", "storeId", "createdAt", "updatedAt" ] }, "status": { "oneOf": [ { "const": "pending" }, { "const": "running" }, { "const": "success" }, { "const": "error" }, { "const": "cancelled" } ] }, "skuInstanceStart": { "oneOf": [ { "type": "null" }, { "type": "number" } ] }, "orderId": { "oneOf": [ { "type": "null" }, { "type": "string", "pattern": "^[a-z0-9]{24}$" } ] }, "orderItemId": { "oneOf": [ { "type": "null" }, { "type": "string", "pattern": "^[a-z0-9]{24}$" } ] }, "priority": { "oneOf": [ { "const": 100 }, { "const": 1000 } ] }, "selectedOptions": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/Recordstringstringnull" } ] }, "id": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "storeId": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "partBuilds": { "type": "array", "items": { "$ref": "#/components/schemas/PartBuildPrintJobsRelationPartBuildStepRelation" } } }, "required": [ "skuId", "skuCopy", "status", "orderId", "orderItemId", "priority", "id", "storeId", "createdAt", "updatedAt", "partBuilds" ] }, "PartBuildPrintJobsRelationPartBuildStepRelation": { "type": "object", "properties": { "partId": { "oneOf": [ { "type": "null" }, { "type": "string", "pattern": "^[a-z0-9]{24}$" } ] }, "skuBuildId": { "oneOf": [ { "type": "null" }, { "type": "string", "pattern": "^[a-z0-9]{24}$" } ] }, "skuId": { "oneOf": [ { "type": "null" }, { "type": "string", "pattern": "^[a-z0-9]{24}$" } ] }, "skuName": { "oneOf": [ { "type": "null" }, { "type": "string", "minLength": 1, "maxLength": 1024 } ] }, "label": { "oneOf": [ { "type": "null" }, { "type": "string", "minLength": 1, "maxLength": 1024 } ] }, "partCopy": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 1024 }, "type": { "oneOf": [ { "const": "scad" }, { "const": "cadquery" }, { "const": "build123d" }, { "const": "stl" }, { "const": "step" }, { "const": "3mf" }, { "const": "gcode3mf" }, { "const": "gcode" } ] }, "description": { "type": "string", "default": "" }, "fileUris": { "type": "array", "items": { "type": "string" } }, "fileHashes": { "type": "array", "items": { "type": "string" } }, "thumbnailUri": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "parameters": { "type": "array", "items": { "type": "object", "properties": { "default": { "oneOf": [ { "type": "number" }, { "type": "string", "minLength": 0, "maxLength": 255 }, { "type": "boolean" } ] }, "options": { "type": "array", "items": { "type": "object", "properties": { "value": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "label": { "type": "string" } }, "required": [ "value" ] } }, "description": { "type": "string" }, "min": { "type": "number" }, "max": { "type": "number" }, "step": { "type": "number" }, "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "type": { "oneOf": [ { "const": "number" }, { "const": "string" }, { "const": "boolean" } ] }, "value": { "oneOf": [ { "type": "number" }, { "type": "string", "minLength": 0, "maxLength": 255 }, { "type": "boolean" } ] } }, "required": [ "name", "type" ] } }, "printTags": { "type": "object", "properties": { "printer.provider": { "type": "string", "minLength": 1 }, "printer.id": { "type": "string", "minLength": 1 }, "printer.nozzleDiameter": { "type": "string", "minLength": 1 }, "printer.modelName": { "type": "string", "minLength": 1 }, "filament.type": { "type": "string", "minLength": 1 }, "user.tags": { "type": "string", "minLength": 1 } } }, "overriddenProcessProfileId": { "oneOf": [ { "type": "null" }, { "type": "string", "pattern": "^[a-z0-9]{24}$" } ] }, "folderId": { "oneOf": [ { "type": "null" }, { "type": "string", "pattern": "^[a-z0-9]{24}$" } ] }, "materials": { "oneOf": [ { "type": "null" }, { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "number", "minimum": 0 }, "color": { "oneOf": [ { "type": "null" }, { "type": "string", "pattern": "^#{0,1}[0-9A-F]{6}|[0-9A-F]{8}$" } ] }, "type": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "skip": { "type": "boolean" }, "name": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "identifier": { "oneOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": [ "index", "color", "type" ] } } ] }, "slicerOverride": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "metadata": { "oneOf": [ { "type": "null" }, { "type": "object", "properties": { "printerModel": { "type": "string" }, "filamentType": { "type": "array", "items": { "type": "string" } }, "filamentColors": { "type": "array", "items": { "type": "string" } }, "filamentDensities": { "type": "array", "items": { "type": "number" } }, "filamentDiameters": { "type": "array", "items": { "type": "number" } }, "nozzleDiameter": { "type": "string" }, "profileCompat": { "type": "object", "properties": { "sliced": { "type": "string" }, "compatible": { "type": "array", "items": { "type": "string" } }, "safe": { "type": "array", "items": { "type": "string" } } }, "required": [ "sliced", "compatible", "safe" ] }, "slicerVersion": { "oneOf": [ { "type": "null" }, { "type": "object", "properties": { "engine": { "oneOf": [ { "const": "orcaslicer" }, { "const": "bambu-studio" }, { "const": "prusaslicer" }, { "const": "superslicer" } ] }, "version": { "type": "string" } }, "required": [ "engine", "version" ] } ] }, "plates": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "locked": { "type": "boolean" }, "filamentMapMode": { "type": "string" }, "filamentMaps": { "type": "array", "items": { "type": "number" } }, "gcodeFile": { "type": "string" }, "thumbnailFile": { "type": "string" }, "thumbnailUploadedUri": { "type": "string" }, "thumbnailNoLightFile": { "type": "string" }, "thumbnailData": { "type": "string" }, "topFile": { "type": "string" }, "pickFile": { "type": "string" }, "topData": { "type": "string", "title": "Base64 PNG data for the top/pick images, staged before upload then cleared", "description": "Base64 PNG data for the top/pick images, staged before upload then cleared." }, "pickData": { "type": "string" }, "topUploadedUri": { "type": "string", "title": "Uploaded URIs for the plate's top-down image and color-coded object pick mask", "description": "Uploaded URIs for the plate's top-down image and color-coded object pick mask.\nUsed by the visual skip-objects picker." }, "pickUploadedUri": { "type": "string" }, "patternBboxFile": { "type": "string" }, "sliced": { "type": "object", "properties": { "index": { "type": "number" }, "extruderType": { "type": "string" }, "nozzleVolumeType": { "type": "string" }, "printerModelId": { "type": "string" }, "nozzleDiameters": { "type": "string" }, "timelapseType": { "type": "string" }, "prediction": { "type": "number" }, "weight": { "type": "number" }, "outside": { "type": "boolean" }, "supportUsed": { "type": "boolean" }, "labelObjectEnabled": { "type": "boolean" }, "filamentMaps": { "type": "string" }, "objects": { "type": "array", "items": { "type": "object", "properties": { "identifyId": { "type": "string" }, "name": { "type": "string" }, "skipped": { "type": "boolean" } }, "required": [ "identifyId", "name", "skipped" ] } }, "filaments": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "trayInfoIdx": { "type": "string" }, "type": { "type": "string" }, "color": { "type": "string" }, "usedM": { "type": "number" }, "usedG": { "type": "number" } }, "required": [ "id", "trayInfoIdx", "type", "color", "usedM", "usedG" ] } }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "msg": { "type": "string" }, "level": { "type": "number" }, "errorCode": { "type": "string" } }, "required": [ "msg", "level", "errorCode" ] } }, "layerFilamentLists": { "type": "array", "items": { "type": "object", "properties": { "filamentList": { "type": "number" }, "layerRanges": { "type": "string" } }, "required": [ "filamentList", "layerRanges" ] } } } }, "filamentIds": { "type": "array", "items": { "type": "string" } } }, "required": [ "id" ] } }, "filamentIds": { "type": "array", "items": { "type": "string" } } }, "required": [ "printerModel", "filamentType", "filamentColors", "nozzleDiameter", "profileCompat" ] } ] }, "slicingEstimate": { "oneOf": [ { "type": "null" }, { "type": "object", "properties": { "estimatedPrintTimeSeconds": { "type": "number" }, "materials": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "number" }, "usedGrams": { "type": "number" }, "usedMeters": { "type": "number" }, "materialType": { "type": "string" }, "color": { "type": "string" } }, "required": [ "index", "usedGrams", "usedMeters", "materialType" ] } }, "totalWeightGrams": { "type": "number" }, "profiles": { "type": "object", "properties": { "machineProfileId": { "type": "string" }, "machineProfileName": { "type": "string" }, "processProfileId": { "type": "string" }, "processProfileName": { "type": "string" }, "filamentProfileIds": { "type": "array", "items": { "type": "string" } }, "filamentProfileNames": { "type": "array", "items": { "type": "string" } } }, "required": [ "machineProfileId", "machineProfileName", "processProfileId", "processProfileName", "filamentProfileIds", "filamentProfileNames" ] }, "slicedAt": { "type": "string" }, "slicerVersion": { "type": "string" }, "plates": { "type": "array", "items": { "type": "object", "properties": { "plateId": { "type": "number" }, "estimatedPrintTimeSeconds": { "type": "number" }, "materials": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "number" }, "usedGrams": { "type": "number" }, "usedMeters": { "type": "number" }, "materialType": { "type": "string" }, "color": { "type": "string" } }, "required": [ "index", "usedGrams", "usedMeters", "materialType" ] } }, "totalWeightGrams": { "type": "number" } }, "required": [ "plateId", "estimatedPrintTimeSeconds", "materials", "totalWeightGrams" ] } } }, "required": [ "estimatedPrintTimeSeconds", "materials", "totalWeightGrams", "slicedAt", "slicerVersion" ] } ] }, "use3MFProcessProfile": { "type": "boolean" }, "arrangeable": { "type": "boolean" }, "userTags": { "type": "array", "items": { "type": "string" } }, "gcodePlateUris": { "oneOf": [ { "type": "null" }, { "type": "object", "properties": {}, "additionalProperties": { "type": "string" } } ] }, "uploadedAt": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "id": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "storeId": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "name", "type", "description", "fileUris", "fileHashes", "thumbnailUri", "parameters", "printTags", "overriddenProcessProfileId", "materials", "id", "storeId", "createdAt", "updatedAt" ] }, "requiredPrinterTags": { "$ref": "#/components/schemas/Tags" }, "quantity": { "type": "number", "minimum": 0, "maximum": 500 }, "numPartsPerSku": { "oneOf": [ { "type": "null" }, { "type": "number" } ] }, "skuInstanceStart": { "oneOf": [ { "type": "null" }, { "type": "number" } ] }, "parameterOverrides": { "type": "array", "items": { "$ref": "#/components/schemas/PartParameterOverride" } }, "status": { "oneOf": [ { "const": "pending" }, { "const": "building" }, { "const": "queued" }, { "const": "fulfilling" }, { "const": "preparing" }, { "const": "sending-to-printer" }, { "const": "printing" }, { "const": "success" }, { "const": "error" }, { "const": "cancelled" } ] }, "outputFiles": { "oneOf": [ { "type": "null" }, { "type": "array", "items": { "type": "string" } } ] }, "thumbnailUri": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "assignmentStartedAt": { "oneOf": [ { "type": "null" }, { "type": "string", "format": "date-time" } ] }, "assignmentCompletedAt": { "oneOf": [ { "type": "null" }, { "type": "string", "format": "date-time" } ] }, "printingStartedAt": { "oneOf": [ { "type": "null" }, { "type": "string", "format": "date-time" } ] }, "printingCompletedAt": { "oneOf": [ { "type": "null" }, { "type": "string", "format": "date-time" } ] }, "printStatus": { "oneOf": [ { "const": "pending" }, { "const": "printing" }, { "const": "success" }, { "const": "error" }, { "const": "cancelled" } ] }, "extensions": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/PartBuildExtensions" } ] }, "materialAssignments": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/MaterialAssignments" } ] }, "priority": { "oneOf": [ { "const": 100 }, { "const": 1000 } ] }, "position": { "oneOf": [ { "const": "front" }, { "const": "back" } ] }, "orderId": { "oneOf": [ { "type": "null" }, { "type": "string", "pattern": "^[a-z0-9]{24}$" } ] }, "orderItemId": { "oneOf": [ { "type": "null" }, { "type": "string", "pattern": "^[a-z0-9]{24}$" } ] }, "linkedPartId": { "oneOf": [ { "type": "null" }, { "type": "string", "pattern": "^[a-z0-9]{24}$" } ] }, "dismissed": { "type": "boolean" }, "id": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "storeId": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "printJobs": { "type": "array", "items": { "$ref": "#/components/schemas/PrintJob" } }, "steps": { "type": "array", "items": { "$ref": "#/components/schemas/PartBuildStep" } } }, "required": [ "partId", "skuBuildId", "skuId", "skuName", "label", "partCopy", "requiredPrinterTags", "quantity", "parameterOverrides", "status", "outputFiles", "thumbnailUri", "assignmentStartedAt", "assignmentCompletedAt", "printingStartedAt", "printingCompletedAt", "printStatus", "materialAssignments", "priority", "position", "orderId", "orderItemId", "linkedPartId", "dismissed", "id", "storeId", "createdAt", "updatedAt", "printJobs", "steps" ] }, "skuIdstringundefinedskuCopystringundefinedstatusstringundefinedskuInstanceStartstringundefinedorderIdstringundefinedorderItemIdstringundefined...5more...updatedAtstringundefinedQuerySettings...": { "type": "object", "properties": { "skuId": { "type": "string" }, "skuCopy": { "type": "string" }, "status": { "type": "string" }, "skuInstanceStart": { "type": "string" }, "orderId": { "type": "string" }, "orderItemId": { "type": "string" }, "priority": { "type": "string" }, "selectedOptions": { "type": "string" }, "id": { "type": "string" }, "storeId": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "sort": { "type": "string", "title": "Sort", "description": "Sort specification in format \"field:asc,field2:desc\"" }, "limit": { "type": "number", "minimum": 1, "maximum": 1000, "title": "Limit", "description": "Maximum number of results to return (default: 100, max: 1000)" }, "offset": { "type": "number", "minimum": 0, "title": "Offset", "description": "Number of results to skip for pagination" }, "fields": { "type": "string", "title": "Fields", "description": "Comma-separated list of fields to return" }, "include": { "type": "string", "title": "Include", "description": "Comma-separated list of relations to include (max 4, max 2 levels deep).\nExample: \"linkedParts,linkedParts.part,folder\"" }, "meta": { "type": "boolean", "title": "Meta", "description": "If true, returns response with metadata (total, count, hasMore, etc.)" }, "hints": { "type": "boolean", "title": "Hints", "description": "If true, returns AI-friendly hints about available actions. Implies meta=true." } } }, "SearchQueryDtoSkuBuild": { "type": "object", "properties": { "filter": { "oneOf": [ { "$ref": "#/components/schemas/LogicalConditionSkuBuild" }, { "$ref": "#/components/schemas/FieldConditionSkuBuild" } ], "title": "Filter", "description": "Complex filter conditions using logical and field operators.\nAvailable field operators: eq, ne, gt, gte, lt, lte, contains, startsWith, endsWith, in, notIn, isNull, between.\nUsage example: {\"filter\": {\"and\": [{\"name\": {\"contains\": \"benchy\"}}, {\"or\": [{\"type\": {\"eq\": \"3mf\"}}, {\"type\": {\"eq\": \"gcode3mf\"}}]}}}" }, "sort": { "type": "string", "title": "Sort", "description": "Sort specification in format \"field:asc,field2:desc\"" }, "limit": { "type": "number", "minimum": 1, "maximum": 1000, "title": "Limit", "description": "Maximum number of results to return (default: 100, max: 1000)" }, "offset": { "type": "number", "minimum": 0, "title": "Offset", "description": "Number of results to skip for pagination" }, "fields": { "type": "string", "title": "Fields", "description": "Comma-separated list of fields to return" }, "include": { "type": "string", "title": "Include", "description": "Comma-separated list of relations to include (max 4, max 2 levels deep).\nExample: \"linkedParts,linkedParts.part,folder\"" }, "meta": { "type": "boolean", "title": "Meta", "description": "If true, returns response with metadata (total, count, hasMore, etc.)" }, "hints": { "type": "boolean", "title": "Hints", "description": "If true, returns AI-friendly hints about available actions. Implies meta=true." } }, "title": "Search Query", "description": "Complete search request with filter conditions and query settings" }, "LogicalConditionSkuBuild": { "type": "object", "properties": { "and": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/LogicalConditionSkuBuild" }, { "$ref": "#/components/schemas/FieldConditionSkuBuild" } ] }, "title": "AND Conditions", "description": "All conditions must be true" }, "or": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/LogicalConditionSkuBuild" }, { "$ref": "#/components/schemas/FieldConditionSkuBuild" } ] }, "title": "OR Conditions", "description": "At least one condition must be true" } }, "title": "Logical Condition", "description": "Logical operators for combining multiple filter conditions" }, "FieldConditionSkuBuild": { "type": "object", "properties": { "skuId": { "$ref": "#/components/schemas/FieldOperators" }, "skuCopy": { "$ref": "#/components/schemas/FieldOperators" }, "status": { "$ref": "#/components/schemas/FieldOperators" }, "skuInstanceStart": { "$ref": "#/components/schemas/FieldOperators" }, "orderId": { "$ref": "#/components/schemas/FieldOperators" }, "orderItemId": { "$ref": "#/components/schemas/FieldOperators" }, "priority": { "$ref": "#/components/schemas/FieldOperators" }, "selectedOptions": { "$ref": "#/components/schemas/FieldOperators" }, "id": { "$ref": "#/components/schemas/FieldOperators" }, "storeId": { "$ref": "#/components/schemas/FieldOperators" }, "createdAt": { "$ref": "#/components/schemas/FieldOperators" }, "updatedAt": { "$ref": "#/components/schemas/FieldOperators" } }, "title": "Field Condition", "description": "Field-based filter conditions where keys are field names and values are field operators" }, "partBuildIdstringundefinedorderstringundefinedbuilderstringundefinedinputFilesstringundefinedinputParametersstringundefinedinputHashstringundefined...13more...updatedAtstringundefinedQuerySettings...": { "type": "object", "properties": { "partBuildId": { "type": "string" }, "order": { "type": "string" }, "builder": { "type": "string" }, "inputFiles": { "type": "string" }, "inputParameters": { "type": "string" }, "inputHash": { "type": "string" }, "cachedBuildStepId": { "type": "string" }, "cachedOutputFile": { "type": "string" }, "outputFiles": { "type": "string" }, "status": { "type": "string" }, "logs": { "type": "string" }, "requiresAssignedPrinter": { "type": "string" }, "nextStepId": { "type": "string" }, "startedAt": { "type": "string" }, "completedAt": { "type": "string" }, "dismissed": { "type": "string" }, "id": { "type": "string" }, "storeId": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "sort": { "type": "string", "title": "Sort", "description": "Sort specification in format \"field:asc,field2:desc\"" }, "limit": { "type": "number", "minimum": 1, "maximum": 1000, "title": "Limit", "description": "Maximum number of results to return (default: 100, max: 1000)" }, "offset": { "type": "number", "minimum": 0, "title": "Offset", "description": "Number of results to skip for pagination" }, "fields": { "type": "string", "title": "Fields", "description": "Comma-separated list of fields to return" }, "include": { "type": "string", "title": "Include", "description": "Comma-separated list of relations to include (max 4, max 2 levels deep).\nExample: \"linkedParts,linkedParts.part,folder\"" }, "meta": { "type": "boolean", "title": "Meta", "description": "If true, returns response with metadata (total, count, hasMore, etc.)" }, "hints": { "type": "boolean", "title": "Hints", "description": "If true, returns AI-friendly hints about available actions. Implies meta=true." } } }, "SearchQueryDtoPartBuildStep": { "type": "object", "properties": { "filter": { "oneOf": [ { "$ref": "#/components/schemas/LogicalConditionPartBuildStep" }, { "$ref": "#/components/schemas/FieldConditionPartBuildStep" } ], "title": "Filter", "description": "Complex filter conditions using logical and field operators.\nAvailable field operators: eq, ne, gt, gte, lt, lte, contains, startsWith, endsWith, in, notIn, isNull, between.\nUsage example: {\"filter\": {\"and\": [{\"name\": {\"contains\": \"benchy\"}}, {\"or\": [{\"type\": {\"eq\": \"3mf\"}}, {\"type\": {\"eq\": \"gcode3mf\"}}]}}}" }, "sort": { "type": "string", "title": "Sort", "description": "Sort specification in format \"field:asc,field2:desc\"" }, "limit": { "type": "number", "minimum": 1, "maximum": 1000, "title": "Limit", "description": "Maximum number of results to return (default: 100, max: 1000)" }, "offset": { "type": "number", "minimum": 0, "title": "Offset", "description": "Number of results to skip for pagination" }, "fields": { "type": "string", "title": "Fields", "description": "Comma-separated list of fields to return" }, "include": { "type": "string", "title": "Include", "description": "Comma-separated list of relations to include (max 4, max 2 levels deep).\nExample: \"linkedParts,linkedParts.part,folder\"" }, "meta": { "type": "boolean", "title": "Meta", "description": "If true, returns response with metadata (total, count, hasMore, etc.)" }, "hints": { "type": "boolean", "title": "Hints", "description": "If true, returns AI-friendly hints about available actions. Implies meta=true." } }, "title": "Search Query", "description": "Complete search request with filter conditions and query settings" }, "LogicalConditionPartBuildStep": { "type": "object", "properties": { "and": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/LogicalConditionPartBuildStep" }, { "$ref": "#/components/schemas/FieldConditionPartBuildStep" } ] }, "title": "AND Conditions", "description": "All conditions must be true" }, "or": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/LogicalConditionPartBuildStep" }, { "$ref": "#/components/schemas/FieldConditionPartBuildStep" } ] }, "title": "OR Conditions", "description": "At least one condition must be true" } }, "title": "Logical Condition", "description": "Logical operators for combining multiple filter conditions" }, "FieldConditionPartBuildStep": { "type": "object", "properties": { "partBuildId": { "$ref": "#/components/schemas/FieldOperators" }, "order": { "$ref": "#/components/schemas/FieldOperators" }, "builder": { "$ref": "#/components/schemas/FieldOperators" }, "inputFiles": { "$ref": "#/components/schemas/FieldOperators" }, "inputParameters": { "$ref": "#/components/schemas/FieldOperators" }, "inputHash": { "$ref": "#/components/schemas/FieldOperators" }, "cachedBuildStepId": { "$ref": "#/components/schemas/FieldOperators" }, "cachedOutputFile": { "$ref": "#/components/schemas/FieldOperators" }, "outputFiles": { "$ref": "#/components/schemas/FieldOperators" }, "status": { "$ref": "#/components/schemas/FieldOperators" }, "logs": { "$ref": "#/components/schemas/FieldOperators" }, "requiresAssignedPrinter": { "$ref": "#/components/schemas/FieldOperators" }, "nextStepId": { "$ref": "#/components/schemas/FieldOperators" }, "startedAt": { "$ref": "#/components/schemas/FieldOperators" }, "completedAt": { "$ref": "#/components/schemas/FieldOperators" }, "dismissed": { "$ref": "#/components/schemas/FieldOperators" }, "id": { "$ref": "#/components/schemas/FieldOperators" }, "storeId": { "$ref": "#/components/schemas/FieldOperators" }, "createdAt": { "$ref": "#/components/schemas/FieldOperators" }, "updatedAt": { "$ref": "#/components/schemas/FieldOperators" } }, "title": "Field Condition", "description": "Field-based filter conditions where keys are field names and values are field operators" }, "Folder": { "type": "object", "properties": { "type": { "oneOf": [ { "const": "part" }, { "const": "sku" } ] }, "name": { "type": "string" }, "parentId": { "oneOf": [ { "type": "null" }, { "type": "string", "pattern": "^[a-z0-9]{24}$" } ] }, "id": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "storeId": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "type", "name", "parentId", "id", "storeId", "createdAt", "updatedAt" ] }, "typestringundefinednamestringundefinedparentIdstringundefinedidstringundefinedstoreIdstringundefinedcreatedAtstringundefinedupdatedAtstringundefinedQuerySettings...": { "type": "object", "properties": { "type": { "type": "string" }, "name": { "type": "string" }, "parentId": { "type": "string" }, "id": { "type": "string" }, "storeId": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "sort": { "type": "string", "title": "Sort", "description": "Sort specification in format \"field:asc,field2:desc\"" }, "limit": { "type": "number", "minimum": 1, "maximum": 1000, "title": "Limit", "description": "Maximum number of results to return (default: 100, max: 1000)" }, "offset": { "type": "number", "minimum": 0, "title": "Offset", "description": "Number of results to skip for pagination" }, "fields": { "type": "string", "title": "Fields", "description": "Comma-separated list of fields to return" }, "include": { "type": "string", "title": "Include", "description": "Comma-separated list of relations to include (max 4, max 2 levels deep).\nExample: \"linkedParts,linkedParts.part,folder\"" }, "meta": { "type": "boolean", "title": "Meta", "description": "If true, returns response with metadata (total, count, hasMore, etc.)" }, "hints": { "type": "boolean", "title": "Hints", "description": "If true, returns AI-friendly hints about available actions. Implies meta=true." } } }, "SearchQueryDtoFolder": { "type": "object", "properties": { "filter": { "oneOf": [ { "$ref": "#/components/schemas/LogicalConditionFolder" }, { "$ref": "#/components/schemas/FieldConditionFolder" } ], "title": "Filter", "description": "Complex filter conditions using logical and field operators.\nAvailable field operators: eq, ne, gt, gte, lt, lte, contains, startsWith, endsWith, in, notIn, isNull, between.\nUsage example: {\"filter\": {\"and\": [{\"name\": {\"contains\": \"benchy\"}}, {\"or\": [{\"type\": {\"eq\": \"3mf\"}}, {\"type\": {\"eq\": \"gcode3mf\"}}]}}}" }, "sort": { "type": "string", "title": "Sort", "description": "Sort specification in format \"field:asc,field2:desc\"" }, "limit": { "type": "number", "minimum": 1, "maximum": 1000, "title": "Limit", "description": "Maximum number of results to return (default: 100, max: 1000)" }, "offset": { "type": "number", "minimum": 0, "title": "Offset", "description": "Number of results to skip for pagination" }, "fields": { "type": "string", "title": "Fields", "description": "Comma-separated list of fields to return" }, "include": { "type": "string", "title": "Include", "description": "Comma-separated list of relations to include (max 4, max 2 levels deep).\nExample: \"linkedParts,linkedParts.part,folder\"" }, "meta": { "type": "boolean", "title": "Meta", "description": "If true, returns response with metadata (total, count, hasMore, etc.)" }, "hints": { "type": "boolean", "title": "Hints", "description": "If true, returns AI-friendly hints about available actions. Implies meta=true." } }, "title": "Search Query", "description": "Complete search request with filter conditions and query settings" }, "LogicalConditionFolder": { "type": "object", "properties": { "and": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/LogicalConditionFolder" }, { "$ref": "#/components/schemas/FieldConditionFolder" } ] }, "title": "AND Conditions", "description": "All conditions must be true" }, "or": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/LogicalConditionFolder" }, { "$ref": "#/components/schemas/FieldConditionFolder" } ] }, "title": "OR Conditions", "description": "At least one condition must be true" } }, "title": "Logical Condition", "description": "Logical operators for combining multiple filter conditions" }, "FieldConditionFolder": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/FieldOperators" }, "name": { "$ref": "#/components/schemas/FieldOperators" }, "parentId": { "$ref": "#/components/schemas/FieldOperators" }, "id": { "$ref": "#/components/schemas/FieldOperators" }, "storeId": { "$ref": "#/components/schemas/FieldOperators" }, "createdAt": { "$ref": "#/components/schemas/FieldOperators" }, "updatedAt": { "$ref": "#/components/schemas/FieldOperators" } }, "title": "Field Condition", "description": "Field-based filter conditions where keys are field names and values are field operators" }, "CreateFolderRequest": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "type": { "oneOf": [ { "const": "part" }, { "const": "sku" } ] }, "parentId": { "oneOf": [ { "type": "null" }, { "type": "string", "pattern": "^[a-z0-9]{24}$" } ] } }, "required": [ "name", "type", "parentId" ] }, "BatchMoveFolderResponse": { "type": "object", "properties": { "folderIds": { "type": "array", "items": { "type": "string", "pattern": "^[a-z0-9]{24}$" } }, "partIds": { "type": "array", "items": { "type": "string", "pattern": "^[a-z0-9]{24}$" } }, "skuIds": { "type": "array", "items": { "type": "string", "pattern": "^[a-z0-9]{24}$" } } }, "required": [ "folderIds", "partIds", "skuIds" ] }, "BatchMoveFolderRequest": { "type": "object", "properties": { "entities": { "type": "object", "properties": { "folderIds": { "type": "array", "items": { "type": "string", "pattern": "^[a-z0-9]{24}$" } }, "partIds": { "type": "array", "items": { "type": "string", "pattern": "^[a-z0-9]{24}$" } }, "skuIds": { "type": "array", "items": { "type": "string", "pattern": "^[a-z0-9]{24}$" } } } }, "toFolderId": { "oneOf": [ { "type": "null" }, { "type": "string", "pattern": "^[a-z0-9]{24}$" } ] } }, "required": [ "entities", "toFolderId" ] }, "RenameFolderRequest": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 255 } }, "required": [ "id", "name" ] }, "DeleteFolderRequest": { "type": "object", "properties": { "folderIds": { "type": "array", "items": { "type": "string", "pattern": "^[a-z0-9]{24}$" } }, "type": { "oneOf": [ { "const": "part" }, { "const": "sku" } ] } }, "required": [ "folderIds", "type" ] }, "Entitlement": { "type": "object", "properties": { "entitlement": { "type": "string" }, "enabledAt": { "type": "string", "format": "date-time" }, "id": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "storeId": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "entitlement", "enabledAt", "id", "storeId", "createdAt", "updatedAt" ] }, "entitlementstringundefinedenabledAtstringundefinedidstringundefinedstoreIdstringundefinedcreatedAtstringundefinedupdatedAtstringundefinedQuerySettings...": { "type": "object", "properties": { "entitlement": { "type": "string" }, "enabledAt": { "type": "string" }, "id": { "type": "string" }, "storeId": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "sort": { "type": "string", "title": "Sort", "description": "Sort specification in format \"field:asc,field2:desc\"" }, "limit": { "type": "number", "minimum": 1, "maximum": 1000, "title": "Limit", "description": "Maximum number of results to return (default: 100, max: 1000)" }, "offset": { "type": "number", "minimum": 0, "title": "Offset", "description": "Number of results to skip for pagination" }, "fields": { "type": "string", "title": "Fields", "description": "Comma-separated list of fields to return" }, "include": { "type": "string", "title": "Include", "description": "Comma-separated list of relations to include (max 4, max 2 levels deep).\nExample: \"linkedParts,linkedParts.part,folder\"" }, "meta": { "type": "boolean", "title": "Meta", "description": "If true, returns response with metadata (total, count, hasMore, etc.)" }, "hints": { "type": "boolean", "title": "Hints", "description": "If true, returns AI-friendly hints about available actions. Implies meta=true." } } }, "SearchQueryDtoEntitlement": { "type": "object", "properties": { "filter": { "oneOf": [ { "$ref": "#/components/schemas/LogicalConditionEntitlement" }, { "$ref": "#/components/schemas/FieldConditionEntitlement" } ], "title": "Filter", "description": "Complex filter conditions using logical and field operators.\nAvailable field operators: eq, ne, gt, gte, lt, lte, contains, startsWith, endsWith, in, notIn, isNull, between.\nUsage example: {\"filter\": {\"and\": [{\"name\": {\"contains\": \"benchy\"}}, {\"or\": [{\"type\": {\"eq\": \"3mf\"}}, {\"type\": {\"eq\": \"gcode3mf\"}}]}}}" }, "sort": { "type": "string", "title": "Sort", "description": "Sort specification in format \"field:asc,field2:desc\"" }, "limit": { "type": "number", "minimum": 1, "maximum": 1000, "title": "Limit", "description": "Maximum number of results to return (default: 100, max: 1000)" }, "offset": { "type": "number", "minimum": 0, "title": "Offset", "description": "Number of results to skip for pagination" }, "fields": { "type": "string", "title": "Fields", "description": "Comma-separated list of fields to return" }, "include": { "type": "string", "title": "Include", "description": "Comma-separated list of relations to include (max 4, max 2 levels deep).\nExample: \"linkedParts,linkedParts.part,folder\"" }, "meta": { "type": "boolean", "title": "Meta", "description": "If true, returns response with metadata (total, count, hasMore, etc.)" }, "hints": { "type": "boolean", "title": "Hints", "description": "If true, returns AI-friendly hints about available actions. Implies meta=true." } }, "title": "Search Query", "description": "Complete search request with filter conditions and query settings" }, "LogicalConditionEntitlement": { "type": "object", "properties": { "and": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/LogicalConditionEntitlement" }, { "$ref": "#/components/schemas/FieldConditionEntitlement" } ] }, "title": "AND Conditions", "description": "All conditions must be true" }, "or": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/LogicalConditionEntitlement" }, { "$ref": "#/components/schemas/FieldConditionEntitlement" } ] }, "title": "OR Conditions", "description": "At least one condition must be true" } }, "title": "Logical Condition", "description": "Logical operators for combining multiple filter conditions" }, "FieldConditionEntitlement": { "type": "object", "properties": { "entitlement": { "$ref": "#/components/schemas/FieldOperators" }, "enabledAt": { "$ref": "#/components/schemas/FieldOperators" }, "id": { "$ref": "#/components/schemas/FieldOperators" }, "storeId": { "$ref": "#/components/schemas/FieldOperators" }, "createdAt": { "$ref": "#/components/schemas/FieldOperators" }, "updatedAt": { "$ref": "#/components/schemas/FieldOperators" } }, "title": "Field Condition", "description": "Field-based filter conditions where keys are field names and values are field operators" }, "Permission": { "type": "object", "properties": { "userId": { "type": "string" }, "permission": { "oneOf": [ { "const": "organization.owner" }, { "const": "organization.edit" }, { "const": "organization.delete" }, { "const": "user.view" }, { "const": "user.invite" }, { "const": "user.edit" }, { "const": "user.delete" }, { "const": "permission.view" }, { "const": "permission.grant" }, { "const": "permission.revoke" }, { "const": "part.view" }, { "const": "part.create" }, { "const": "part.edit" }, { "const": "part.delete" }, { "const": "part.export" }, { "const": "sku.view" }, { "const": "sku.create" }, { "const": "sku.edit" }, { "const": "sku.delete" }, { "const": "material.view" }, { "const": "material.create" }, { "const": "material.edit" }, { "const": "material.delete" }, { "const": "material.instance.view" }, { "const": "material.instance.create" }, { "const": "material.instance.edit" }, { "const": "material.instance.delete" }, { "const": "printer.view" }, { "const": "printer.create" }, { "const": "printer.edit" }, { "const": "printer.delete" }, { "const": "printer.control" }, { "const": "printer.ready" }, { "const": "printer.config" }, { "const": "printer.stats" }, { "const": "printer.camera" }, { "const": "profile.view" }, { "const": "profile.create" }, { "const": "profile.edit" }, { "const": "profile.delete" }, { "const": "queue.view" }, { "const": "queue.manage" }, { "const": "queue.override" }, { "const": "job.create" }, { "const": "job.edit.own" }, { "const": "job.edit.all" }, { "const": "job.delete.own" }, { "const": "job.delete.all" }, { "const": "build.view" }, { "const": "build.create" }, { "const": "build.edit" }, { "const": "build.delete" }, { "const": "settings.view" }, { "const": "settings.edit" }, { "const": "integration.view" }, { "const": "integration.manage" }, { "const": "subscription.view" }, { "const": "subscription.manage" }, { "const": "analytics.view" }, { "const": "reports.generate" }, { "const": "audit.log.view" }, { "const": "audit.logs.configure" }, { "const": "order.view" }, { "const": "order.create" }, { "const": "order.edit" }, { "const": "order.delete" }, { "const": "order.print" }, { "const": "apiKey.view" }, { "const": "apiKey.create" }, { "const": "apiKey.edit" }, { "const": "apiKey.delete" }, { "const": "file.download" }, { "const": "maintenance.view" }, { "const": "maintenance.create" }, { "const": "maintenance.edit" }, { "const": "maintenance.delete" }, { "const": "maintenance.complete" }, { "const": "internal.shopify" }, { "const": "queue.admin" }, { "const": "part.viewer" }, { "const": "part.editor" }, { "const": "sku.viewer" }, { "const": "sku.editor" }, { "const": "orders.admin" }, { "const": "material.viewer" }, { "const": "material.editor" }, { "const": "printer.viewer" }, { "const": "printer.editor" }, { "const": "profile.viewer" }, { "const": "profile.editor" }, { "const": "settings.admin" }, { "const": "subscription.admin" } ] }, "storeId": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "id": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "userId", "permission", "storeId", "id", "createdAt", "updatedAt" ], "description": "Represents a user permission in the system" }, "userIdstringundefinedpermissionstringundefinedstoreIdstringundefinedidstringundefinedcreatedAtstringundefinedupdatedAtstringundefinedQuerySettings...": { "type": "object", "properties": { "userId": { "type": "string" }, "permission": { "type": "string" }, "storeId": { "type": "string" }, "id": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "sort": { "type": "string", "title": "Sort", "description": "Sort specification in format \"field:asc,field2:desc\"" }, "limit": { "type": "number", "minimum": 1, "maximum": 1000, "title": "Limit", "description": "Maximum number of results to return (default: 100, max: 1000)" }, "offset": { "type": "number", "minimum": 0, "title": "Offset", "description": "Number of results to skip for pagination" }, "fields": { "type": "string", "title": "Fields", "description": "Comma-separated list of fields to return" }, "include": { "type": "string", "title": "Include", "description": "Comma-separated list of relations to include (max 4, max 2 levels deep).\nExample: \"linkedParts,linkedParts.part,folder\"" }, "meta": { "type": "boolean", "title": "Meta", "description": "If true, returns response with metadata (total, count, hasMore, etc.)" }, "hints": { "type": "boolean", "title": "Hints", "description": "If true, returns AI-friendly hints about available actions. Implies meta=true." } } }, "SearchQueryDtoPermission": { "type": "object", "properties": { "filter": { "oneOf": [ { "$ref": "#/components/schemas/LogicalConditionPermission" }, { "$ref": "#/components/schemas/FieldConditionPermission" } ], "title": "Filter", "description": "Complex filter conditions using logical and field operators.\nAvailable field operators: eq, ne, gt, gte, lt, lte, contains, startsWith, endsWith, in, notIn, isNull, between.\nUsage example: {\"filter\": {\"and\": [{\"name\": {\"contains\": \"benchy\"}}, {\"or\": [{\"type\": {\"eq\": \"3mf\"}}, {\"type\": {\"eq\": \"gcode3mf\"}}]}}}" }, "sort": { "type": "string", "title": "Sort", "description": "Sort specification in format \"field:asc,field2:desc\"" }, "limit": { "type": "number", "minimum": 1, "maximum": 1000, "title": "Limit", "description": "Maximum number of results to return (default: 100, max: 1000)" }, "offset": { "type": "number", "minimum": 0, "title": "Offset", "description": "Number of results to skip for pagination" }, "fields": { "type": "string", "title": "Fields", "description": "Comma-separated list of fields to return" }, "include": { "type": "string", "title": "Include", "description": "Comma-separated list of relations to include (max 4, max 2 levels deep).\nExample: \"linkedParts,linkedParts.part,folder\"" }, "meta": { "type": "boolean", "title": "Meta", "description": "If true, returns response with metadata (total, count, hasMore, etc.)" }, "hints": { "type": "boolean", "title": "Hints", "description": "If true, returns AI-friendly hints about available actions. Implies meta=true." } }, "title": "Search Query", "description": "Complete search request with filter conditions and query settings" }, "LogicalConditionPermission": { "type": "object", "properties": { "and": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/LogicalConditionPermission" }, { "$ref": "#/components/schemas/FieldConditionPermission" } ] }, "title": "AND Conditions", "description": "All conditions must be true" }, "or": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/LogicalConditionPermission" }, { "$ref": "#/components/schemas/FieldConditionPermission" } ] }, "title": "OR Conditions", "description": "At least one condition must be true" } }, "title": "Logical Condition", "description": "Logical operators for combining multiple filter conditions" }, "FieldConditionPermission": { "type": "object", "properties": { "userId": { "$ref": "#/components/schemas/FieldOperators" }, "permission": { "$ref": "#/components/schemas/FieldOperators" }, "storeId": { "$ref": "#/components/schemas/FieldOperators" }, "id": { "$ref": "#/components/schemas/FieldOperators" }, "createdAt": { "$ref": "#/components/schemas/FieldOperators" }, "updatedAt": { "$ref": "#/components/schemas/FieldOperators" } }, "title": "Field Condition", "description": "Field-based filter conditions where keys are field names and values are field operators" }, "GetAllPermissionsForUserResponse": { "type": "object", "properties": { "owner": { "type": "boolean" }, "permissions": { "type": "array", "items": { "$ref": "#/components/schemas/GetUserPermissionResponse" } }, "roles": { "type": "array", "items": { "type": "string" }, "description": "Role IDs granted to the user in this store" }, "roleNames": { "type": "array", "items": { "type": "string" }, "description": "Role names (system role keys like \"operator\") for readability" }, "effectivePermissions": { "type": "array", "items": { "oneOf": [ { "const": "organization.owner" }, { "const": "organization.edit" }, { "const": "organization.delete" }, { "const": "user.view" }, { "const": "user.invite" }, { "const": "user.edit" }, { "const": "user.delete" }, { "const": "permission.view" }, { "const": "permission.grant" }, { "const": "permission.revoke" }, { "const": "part.view" }, { "const": "part.create" }, { "const": "part.edit" }, { "const": "part.delete" }, { "const": "part.export" }, { "const": "sku.view" }, { "const": "sku.create" }, { "const": "sku.edit" }, { "const": "sku.delete" }, { "const": "material.view" }, { "const": "material.create" }, { "const": "material.edit" }, { "const": "material.delete" }, { "const": "material.instance.view" }, { "const": "material.instance.create" }, { "const": "material.instance.edit" }, { "const": "material.instance.delete" }, { "const": "printer.view" }, { "const": "printer.create" }, { "const": "printer.edit" }, { "const": "printer.delete" }, { "const": "printer.control" }, { "const": "printer.ready" }, { "const": "printer.config" }, { "const": "printer.stats" }, { "const": "printer.camera" }, { "const": "profile.view" }, { "const": "profile.create" }, { "const": "profile.edit" }, { "const": "profile.delete" }, { "const": "queue.view" }, { "const": "queue.manage" }, { "const": "queue.override" }, { "const": "job.create" }, { "const": "job.edit.own" }, { "const": "job.edit.all" }, { "const": "job.delete.own" }, { "const": "job.delete.all" }, { "const": "build.view" }, { "const": "build.create" }, { "const": "build.edit" }, { "const": "build.delete" }, { "const": "settings.view" }, { "const": "settings.edit" }, { "const": "integration.view" }, { "const": "integration.manage" }, { "const": "subscription.view" }, { "const": "subscription.manage" }, { "const": "analytics.view" }, { "const": "reports.generate" }, { "const": "audit.log.view" }, { "const": "audit.logs.configure" }, { "const": "order.view" }, { "const": "order.create" }, { "const": "order.edit" }, { "const": "order.delete" }, { "const": "order.print" }, { "const": "apiKey.view" }, { "const": "apiKey.create" }, { "const": "apiKey.edit" }, { "const": "apiKey.delete" }, { "const": "file.download" }, { "const": "maintenance.view" }, { "const": "maintenance.create" }, { "const": "maintenance.edit" }, { "const": "maintenance.delete" }, { "const": "maintenance.complete" }, { "const": "internal.shopify" }, { "const": "queue.admin" }, { "const": "part.viewer" }, { "const": "part.editor" }, { "const": "sku.viewer" }, { "const": "sku.editor" }, { "const": "orders.admin" }, { "const": "material.viewer" }, { "const": "material.editor" }, { "const": "printer.viewer" }, { "const": "printer.editor" }, { "const": "profile.viewer" }, { "const": "profile.editor" }, { "const": "settings.admin" }, { "const": "subscription.admin" } ] }, "description": "Effective permission set (direct + role-based + owner)" } }, "required": [ "owner", "permissions" ] }, "GetUserPermissionResponse": { "type": "object", "properties": { "userId": { "type": "string" }, "permission": { "oneOf": [ { "const": "organization.owner" }, { "const": "organization.edit" }, { "const": "organization.delete" }, { "const": "user.view" }, { "const": "user.invite" }, { "const": "user.edit" }, { "const": "user.delete" }, { "const": "permission.view" }, { "const": "permission.grant" }, { "const": "permission.revoke" }, { "const": "part.view" }, { "const": "part.create" }, { "const": "part.edit" }, { "const": "part.delete" }, { "const": "part.export" }, { "const": "sku.view" }, { "const": "sku.create" }, { "const": "sku.edit" }, { "const": "sku.delete" }, { "const": "material.view" }, { "const": "material.create" }, { "const": "material.edit" }, { "const": "material.delete" }, { "const": "material.instance.view" }, { "const": "material.instance.create" }, { "const": "material.instance.edit" }, { "const": "material.instance.delete" }, { "const": "printer.view" }, { "const": "printer.create" }, { "const": "printer.edit" }, { "const": "printer.delete" }, { "const": "printer.control" }, { "const": "printer.ready" }, { "const": "printer.config" }, { "const": "printer.stats" }, { "const": "printer.camera" }, { "const": "profile.view" }, { "const": "profile.create" }, { "const": "profile.edit" }, { "const": "profile.delete" }, { "const": "queue.view" }, { "const": "queue.manage" }, { "const": "queue.override" }, { "const": "job.create" }, { "const": "job.edit.own" }, { "const": "job.edit.all" }, { "const": "job.delete.own" }, { "const": "job.delete.all" }, { "const": "build.view" }, { "const": "build.create" }, { "const": "build.edit" }, { "const": "build.delete" }, { "const": "settings.view" }, { "const": "settings.edit" }, { "const": "integration.view" }, { "const": "integration.manage" }, { "const": "subscription.view" }, { "const": "subscription.manage" }, { "const": "analytics.view" }, { "const": "reports.generate" }, { "const": "audit.log.view" }, { "const": "audit.logs.configure" }, { "const": "order.view" }, { "const": "order.create" }, { "const": "order.edit" }, { "const": "order.delete" }, { "const": "order.print" }, { "const": "apiKey.view" }, { "const": "apiKey.create" }, { "const": "apiKey.edit" }, { "const": "apiKey.delete" }, { "const": "file.download" }, { "const": "maintenance.view" }, { "const": "maintenance.create" }, { "const": "maintenance.edit" }, { "const": "maintenance.delete" }, { "const": "maintenance.complete" }, { "const": "internal.shopify" }, { "const": "queue.admin" }, { "const": "part.viewer" }, { "const": "part.editor" }, { "const": "sku.viewer" }, { "const": "sku.editor" }, { "const": "orders.admin" }, { "const": "material.viewer" }, { "const": "material.editor" }, { "const": "printer.viewer" }, { "const": "printer.editor" }, { "const": "profile.viewer" }, { "const": "profile.editor" }, { "const": "settings.admin" }, { "const": "subscription.admin" } ] }, "id": { "type": "string", "pattern": "^[a-z0-9]{24}$" } }, "required": [ "userId", "permission", "id" ] }, "RoleSummary": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "description": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "isSystem": { "type": "boolean" } }, "required": [ "id", "name", "description", "isSystem" ] }, "RoleWithPermissions": { "type": "object", "properties": { "permissions": { "type": "array", "items": { "oneOf": [ { "const": "organization.owner" }, { "const": "organization.edit" }, { "const": "organization.delete" }, { "const": "user.view" }, { "const": "user.invite" }, { "const": "user.edit" }, { "const": "user.delete" }, { "const": "permission.view" }, { "const": "permission.grant" }, { "const": "permission.revoke" }, { "const": "part.view" }, { "const": "part.create" }, { "const": "part.edit" }, { "const": "part.delete" }, { "const": "part.export" }, { "const": "sku.view" }, { "const": "sku.create" }, { "const": "sku.edit" }, { "const": "sku.delete" }, { "const": "material.view" }, { "const": "material.create" }, { "const": "material.edit" }, { "const": "material.delete" }, { "const": "material.instance.view" }, { "const": "material.instance.create" }, { "const": "material.instance.edit" }, { "const": "material.instance.delete" }, { "const": "printer.view" }, { "const": "printer.create" }, { "const": "printer.edit" }, { "const": "printer.delete" }, { "const": "printer.control" }, { "const": "printer.ready" }, { "const": "printer.config" }, { "const": "printer.stats" }, { "const": "printer.camera" }, { "const": "profile.view" }, { "const": "profile.create" }, { "const": "profile.edit" }, { "const": "profile.delete" }, { "const": "queue.view" }, { "const": "queue.manage" }, { "const": "queue.override" }, { "const": "job.create" }, { "const": "job.edit.own" }, { "const": "job.edit.all" }, { "const": "job.delete.own" }, { "const": "job.delete.all" }, { "const": "build.view" }, { "const": "build.create" }, { "const": "build.edit" }, { "const": "build.delete" }, { "const": "settings.view" }, { "const": "settings.edit" }, { "const": "integration.view" }, { "const": "integration.manage" }, { "const": "subscription.view" }, { "const": "subscription.manage" }, { "const": "analytics.view" }, { "const": "reports.generate" }, { "const": "audit.log.view" }, { "const": "audit.logs.configure" }, { "const": "order.view" }, { "const": "order.create" }, { "const": "order.edit" }, { "const": "order.delete" }, { "const": "order.print" }, { "const": "apiKey.view" }, { "const": "apiKey.create" }, { "const": "apiKey.edit" }, { "const": "apiKey.delete" }, { "const": "file.download" }, { "const": "maintenance.view" }, { "const": "maintenance.create" }, { "const": "maintenance.edit" }, { "const": "maintenance.delete" }, { "const": "maintenance.complete" }, { "const": "internal.shopify" }, { "const": "queue.admin" }, { "const": "part.viewer" }, { "const": "part.editor" }, { "const": "sku.viewer" }, { "const": "sku.editor" }, { "const": "orders.admin" }, { "const": "material.viewer" }, { "const": "material.editor" }, { "const": "printer.viewer" }, { "const": "printer.editor" }, { "const": "profile.viewer" }, { "const": "profile.editor" }, { "const": "settings.admin" }, { "const": "subscription.admin" } ] } }, "id": { "type": "string" }, "name": { "type": "string" }, "description": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "isSystem": { "type": "boolean" } }, "required": [ "permissions", "id", "name", "description", "isSystem" ] }, "SendCommandRequest": { "type": "object", "properties": { "command": { "oneOf": [ { "$ref": "#/components/schemas/SetSlotInfoCommand" }, { "type": "object", "properties": { "command": { "const": "stop" } }, "required": [ "command" ] }, { "type": "object", "properties": { "command": { "const": "pause" } }, "required": [ "command" ] }, { "type": "object", "properties": { "command": { "const": "resume" } }, "required": [ "command" ] }, { "type": "object", "properties": { "command": { "const": "resync-data" } }, "required": [ "command" ] }, { "type": "object", "properties": { "command": { "const": "unload-filament" } }, "required": [ "command" ] }, { "type": "object", "properties": { "command": { "const": "load-filament" }, "targetTemp": { "type": "number", "minimum": 0, "maximum": 300 }, "currentTemp": { "type": "number", "minimum": 0, "maximum": 300 }, "targetSlot": { "$ref": "#/components/schemas/CommandMaterialSlot" } }, "required": [ "command", "targetTemp", "currentTemp", "targetSlot" ] }, { "type": "object", "properties": { "command": { "const": "led-control" }, "ref": { "type": "string", "description": "Light component ref: \"light_chamber\", \"light_work\"" }, "state": { "oneOf": [ { "const": "on" }, { "const": "off" } ] } }, "required": [ "command", "ref", "state" ] }, { "type": "object", "properties": { "command": { "const": "set-temperature" }, "ref": { "type": "string", "description": "Component ref: \"nozzle_0\", \"bed_0\", \"chamber_0\"" }, "temperature": { "type": "number", "minimum": 0, "maximum": 300 } }, "required": [ "command", "ref", "temperature" ] }, { "type": "object", "properties": { "command": { "const": "select-tool" }, "ref": { "type": "string", "description": "Tool or nozzle ref: \"tool_0\", \"nozzle_0\"" } }, "required": [ "command", "ref" ] }, { "type": "object", "properties": { "command": { "const": "home-axis" }, "axes": { "type": "object", "properties": { "x": { "type": "boolean" }, "y": { "type": "boolean" }, "z": { "type": "boolean" } } } }, "required": [ "command", "axes" ] }, { "type": "object", "properties": { "command": { "const": "move-axis" }, "axes": { "type": "object", "properties": { "x": { "type": "number", "minimum": -100, "maximum": 100 }, "y": { "type": "number", "minimum": -100, "maximum": 100 }, "z": { "type": "number", "minimum": -100, "maximum": 100 }, "e": { "type": "number", "minimum": -100, "maximum": 100 } } } }, "required": [ "command", "axes" ] }, { "type": "object", "properties": { "command": { "const": "set-fan" }, "ref": { "type": "string", "description": "Fan component ref: \"fan_part\", \"fan_aux\", \"fan_chamber\"" }, "speed": { "type": "number", "minimum": 0, "maximum": 100 } }, "required": [ "command", "ref", "speed" ] }, { "type": "object", "properties": { "command": { "const": "extrude-filament" }, "ref": { "type": "string", "description": "Nozzle ref, defaults to active nozzle if omitted" }, "amount": { "type": "number" } }, "required": [ "command", "amount" ] }, { "type": "object", "properties": { "command": { "const": "calibration" }, "option_value": { "type": "number" } }, "required": [ "command", "option_value" ] }, { "type": "object", "properties": { "command": { "const": "refresh-slot" }, "amsId": { "type": "number" }, "slotId": { "type": "number" } }, "required": [ "command", "amsId", "slotId" ] }, { "type": "object", "properties": { "command": { "const": "skip-objects" }, "objectIds": { "type": "array", "items": { "type": "number" } } }, "required": [ "command", "objectIds" ] } ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^[a-z0-9]{24}$" } } }, "required": [ "command", "ids" ] }, "SetSlotInfoCommand": { "type": "object", "properties": { "command": { "const": "set-slot-info" }, "info": { "type": "object", "properties": { "amsId": { "type": "number" }, "slotId": { "type": "number" }, "identifier": { "type": "string" }, "color": { "type": "string" }, "nozzleTempMin": { "type": "number" }, "nozzleTempMax": { "type": "number" }, "trayType": { "type": "string" } }, "required": [ "slotId", "nozzleTempMin", "nozzleTempMax", "trayType" ] } }, "required": [ "command", "info" ] }, "CommandMaterialSlot": { "type": "object", "properties": { "amsIndex": { "type": "number" }, "slotIndex": { "type": "number" } }, "required": [ "amsIndex", "slotIndex" ], "description": "Visual slot position for material mapping in print commands" }, "GetStoreSettingsResponse": { "type": "object", "properties": { "id": { "type": "string" }, "storeId": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "slicer": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "processLowPriorityJobs": { "type": "boolean" }, "automaticQueueMatching": { "type": "boolean", "description": "When false, every background QueueRun event short-circuits inside\n`matchPrintersAndJobs` and the auto-matcher does not assign jobs. The\nqueue page surfaces a \"Match queue now\" button that bypasses this gate\nby passing `manual: true` to the matcher. Defaults to true so existing\nstores keep their current behaviour." }, "currency": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "currencySymbol": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "defaultPrinterUserProfileId": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "defaultPrinterSystemProfileId": { "oneOf": [ { "type": "null" }, { "type": "number" } ] }, "defaultProcessUserProfileId": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "defaultProcessSystemProfileId": { "oneOf": [ { "type": "null" }, { "type": "number" } ] }, "defaultFallbackFilamentUserProfileId": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "defaultFallbackFilamentSystemProfileId": { "oneOf": [ { "type": "null" }, { "type": "number" } ] }, "experimentalFeatures": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/ExperimentalFeatures" } ] }, "generalSettings": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/GeneralSettings" } ] } }, "required": [ "id", "storeId", "createdAt", "updatedAt", "slicer", "processLowPriorityJobs", "automaticQueueMatching", "currency", "currencySymbol", "defaultPrinterUserProfileId", "defaultPrinterSystemProfileId", "defaultProcessUserProfileId", "defaultProcessSystemProfileId", "defaultFallbackFilamentUserProfileId", "defaultFallbackFilamentSystemProfileId", "experimentalFeatures", "generalSettings" ] }, "ExperimentalFeatures": { "type": "object", "properties": { "financial-tracking": { "type": "boolean" } } }, "GeneralSettings": { "type": "object", "properties": { "autoMatchMaterialsNewPart": { "type": "boolean" }, "enableTimelapse": { "type": "boolean", "description": "When true, the cloud renders a timelapse video for each completed print\nby stitching together the snapshot history captured by Fuse during the\nprint. New stores default to true via createDefaultSettings so the\nfeature is on out of the box; stores that don't want the encode cost\ncan toggle it off in store settings." }, "enableCompletionSnapshot": { "type": "boolean", "description": "When true, Fuse captures a single fresh JPEG near the end of each print\n(last layer / 95% progress / FINISH transition, in that order) and\nuploads it as the print-job's `cameraThumbnailUri`. Independent from\n`enableTimelapse` — a store can have completion snapshots without\npaying the timelapse encode cost, or vice versa. New stores default to\ntrue via createDefaultSettings." }, "amsSlotSelectionStrategy": { "oneOf": [ { "const": "lowest-index" }, { "const": "highest-index" }, { "const": "most-empty" }, { "const": "most-full" } ], "description": "Controls which slot the queue matcher assigns when a job's material is\nloaded in multiple slots on the same printer. Absent is treated as\n`lowest-index` (left-to-right), so existing stores get deterministic\nleft-to-right assignment without any configuration." }, "fabmaticIgnoredErrorCodes": { "type": "array", "items": { "$ref": "#/components/schemas/FabmaticIgnoredErrorCode" }, "description": "Error codes the store wants ignored when deciding whether a printer\nerror should turn off FabMatic (continuous printing). Codes are matched\nformat-insensitively (case, dashes, underscores and leading zeros are\nignored) against the printer's health `errors` and the print `printError`\ncode. (Health `warnings` never turn FabMatic off, so they are not part of\nthis decision.) If every error present on a finished/errored print matches\nan entry here, FabMatic stays enabled and the queue keeps advancing.\nAbsent/empty means no codes are ignored (current behaviour).\n\nCodes vary in length and format across printer brands: print errors are\noften 8 hex chars (\"0500-400E\"/\"0500400E\"/decimal \"83902478\") while health\ncodes can be 16 hex chars (\"0582040000010045\"). Separators are optional and\nignored when matching." } } }, "FabmaticIgnoredErrorCode": { "type": "object", "properties": { "code": { "type": "string" }, "note": { "type": "string" } }, "required": [ "code" ], "description": "A single entry in the FabMatic ignored-error-codes list: the printer error\ncode to ignore, plus an optional human note explaining why it's safe to\nignore (e.g. \"humidity sensor reading, harmless on this unit\")." }, "UpdateStoreSettingsRequest": { "type": "object", "properties": { "slicer": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "processLowPriorityJobs": { "type": "boolean" }, "automaticQueueMatching": { "type": "boolean" }, "currency": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "currencySymbol": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "defaultPrinterUserProfileId": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "defaultPrinterSystemProfileId": { "oneOf": [ { "type": "null" }, { "type": "number" } ] }, "defaultProcessUserProfileId": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "defaultProcessSystemProfileId": { "oneOf": [ { "type": "null" }, { "type": "number" } ] }, "defaultFallbackFilamentUserProfileId": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "defaultFallbackFilamentSystemProfileId": { "oneOf": [ { "type": "null" }, { "type": "number" } ] }, "experimentalFeatures": { "$ref": "#/components/schemas/ExperimentalFeatures" }, "generalSettings": { "$ref": "#/components/schemas/GeneralSettings" } } }, "GetAllSlicerVersionsResponse": { "type": "object", "properties": { "slicerVersions": { "type": "array", "items": { "$ref": "#/components/schemas/SlicerVersion" } } }, "required": [ "slicerVersions" ] }, "SlicerVersion": { "type": "object", "properties": { "id": { "type": "string" }, "engine": { "oneOf": [ { "const": "orcaslicer" }, { "const": "bambu-studio" }, { "const": "prusaslicer" }, { "const": "superslicer" } ] }, "version": { "type": "string" }, "order": { "type": "number" }, "latest": { "type": "boolean" }, "default": { "type": "boolean" } }, "required": [ "id", "engine", "version", "order", "latest", "default" ] }, "SearchQueryDtoNotificationSetting": { "type": "object", "properties": { "filter": { "oneOf": [ { "$ref": "#/components/schemas/LogicalConditionNotificationSetting" }, { "$ref": "#/components/schemas/FieldConditionNotificationSetting" } ], "title": "Filter", "description": "Complex filter conditions using logical and field operators.\nAvailable field operators: eq, ne, gt, gte, lt, lte, contains, startsWith, endsWith, in, notIn, isNull, between.\nUsage example: {\"filter\": {\"and\": [{\"name\": {\"contains\": \"benchy\"}}, {\"or\": [{\"type\": {\"eq\": \"3mf\"}}, {\"type\": {\"eq\": \"gcode3mf\"}}]}}}" }, "sort": { "type": "string", "title": "Sort", "description": "Sort specification in format \"field:asc,field2:desc\"" }, "limit": { "type": "number", "minimum": 1, "maximum": 1000, "title": "Limit", "description": "Maximum number of results to return (default: 100, max: 1000)" }, "offset": { "type": "number", "minimum": 0, "title": "Offset", "description": "Number of results to skip for pagination" }, "fields": { "type": "string", "title": "Fields", "description": "Comma-separated list of fields to return" }, "include": { "type": "string", "title": "Include", "description": "Comma-separated list of relations to include (max 4, max 2 levels deep).\nExample: \"linkedParts,linkedParts.part,folder\"" }, "meta": { "type": "boolean", "title": "Meta", "description": "If true, returns response with metadata (total, count, hasMore, etc.)" }, "hints": { "type": "boolean", "title": "Hints", "description": "If true, returns AI-friendly hints about available actions. Implies meta=true." } }, "title": "Search Query", "description": "Complete search request with filter conditions and query settings" }, "LogicalConditionNotificationSetting": { "type": "object", "properties": { "and": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/LogicalConditionNotificationSetting" }, { "$ref": "#/components/schemas/FieldConditionNotificationSetting" } ] }, "title": "AND Conditions", "description": "All conditions must be true" }, "or": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/LogicalConditionNotificationSetting" }, { "$ref": "#/components/schemas/FieldConditionNotificationSetting" } ] }, "title": "OR Conditions", "description": "At least one condition must be true" } }, "title": "Logical Condition", "description": "Logical operators for combining multiple filter conditions" }, "FieldConditionNotificationSetting": { "type": "object", "properties": { "enabled": { "$ref": "#/components/schemas/FieldOperators" }, "channel": { "$ref": "#/components/schemas/FieldOperators" }, "onJobSucceeded": { "$ref": "#/components/schemas/FieldOperators" }, "onJobFailed": { "$ref": "#/components/schemas/FieldOperators" }, "onJobStarted": { "$ref": "#/components/schemas/FieldOperators" }, "onJobCancelled": { "$ref": "#/components/schemas/FieldOperators" }, "onPrinterHmsError": { "$ref": "#/components/schemas/FieldOperators" }, "onPrinterHmsWarning": { "$ref": "#/components/schemas/FieldOperators" }, "onPrinterOffline": { "$ref": "#/components/schemas/FieldOperators" }, "onPrinterOnline": { "$ref": "#/components/schemas/FieldOperators" }, "onPrinterContinuousPrintDisabled": { "$ref": "#/components/schemas/FieldOperators" }, "onOrderCreatedManual": { "$ref": "#/components/schemas/FieldOperators" }, "onOrderCreatedRetail": { "$ref": "#/components/schemas/FieldOperators" }, "onOrderCancelled": { "$ref": "#/components/schemas/FieldOperators" }, "onOrderClosed": { "$ref": "#/components/schemas/FieldOperators" }, "onOrdersAutoPrinted": { "$ref": "#/components/schemas/FieldOperators" }, "onMaintenanceModeOn": { "$ref": "#/components/schemas/FieldOperators" }, "onMaintenanceModeOff": { "$ref": "#/components/schemas/FieldOperators" }, "onMaintenanceDueSoon": { "$ref": "#/components/schemas/FieldOperators" }, "onMaintenanceOverdue": { "$ref": "#/components/schemas/FieldOperators" }, "onMaterialUsageRecorded": { "$ref": "#/components/schemas/FieldOperators" }, "id": { "$ref": "#/components/schemas/FieldOperators" }, "storeId": { "$ref": "#/components/schemas/FieldOperators" }, "createdAt": { "$ref": "#/components/schemas/FieldOperators" }, "updatedAt": { "$ref": "#/components/schemas/FieldOperators" } }, "title": "Field Condition", "description": "Field-based filter conditions where keys are field names and values are field operators" }, "SearchQueryDtoStoreSettings": { "type": "object", "properties": { "filter": { "oneOf": [ { "$ref": "#/components/schemas/LogicalConditionStoreSettings" }, { "$ref": "#/components/schemas/FieldConditionStoreSettings" } ], "title": "Filter", "description": "Complex filter conditions using logical and field operators.\nAvailable field operators: eq, ne, gt, gte, lt, lte, contains, startsWith, endsWith, in, notIn, isNull, between.\nUsage example: {\"filter\": {\"and\": [{\"name\": {\"contains\": \"benchy\"}}, {\"or\": [{\"type\": {\"eq\": \"3mf\"}}, {\"type\": {\"eq\": \"gcode3mf\"}}]}}}" }, "sort": { "type": "string", "title": "Sort", "description": "Sort specification in format \"field:asc,field2:desc\"" }, "limit": { "type": "number", "minimum": 1, "maximum": 1000, "title": "Limit", "description": "Maximum number of results to return (default: 100, max: 1000)" }, "offset": { "type": "number", "minimum": 0, "title": "Offset", "description": "Number of results to skip for pagination" }, "fields": { "type": "string", "title": "Fields", "description": "Comma-separated list of fields to return" }, "include": { "type": "string", "title": "Include", "description": "Comma-separated list of relations to include (max 4, max 2 levels deep).\nExample: \"linkedParts,linkedParts.part,folder\"" }, "meta": { "type": "boolean", "title": "Meta", "description": "If true, returns response with metadata (total, count, hasMore, etc.)" }, "hints": { "type": "boolean", "title": "Hints", "description": "If true, returns AI-friendly hints about available actions. Implies meta=true." } }, "title": "Search Query", "description": "Complete search request with filter conditions and query settings" }, "LogicalConditionStoreSettings": { "type": "object", "properties": { "and": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/LogicalConditionStoreSettings" }, { "$ref": "#/components/schemas/FieldConditionStoreSettings" } ] }, "title": "AND Conditions", "description": "All conditions must be true" }, "or": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/LogicalConditionStoreSettings" }, { "$ref": "#/components/schemas/FieldConditionStoreSettings" } ] }, "title": "OR Conditions", "description": "At least one condition must be true" } }, "title": "Logical Condition", "description": "Logical operators for combining multiple filter conditions" }, "FieldConditionStoreSettings": { "type": "object", "properties": { "id": { "$ref": "#/components/schemas/FieldOperators" }, "storeId": { "$ref": "#/components/schemas/FieldOperators" }, "createdAt": { "$ref": "#/components/schemas/FieldOperators" }, "updatedAt": { "$ref": "#/components/schemas/FieldOperators" }, "slicer": { "$ref": "#/components/schemas/FieldOperators" }, "processLowPriorityJobs": { "$ref": "#/components/schemas/FieldOperators" }, "automaticQueueMatching": { "$ref": "#/components/schemas/FieldOperators", "description": "When false, every background QueueRun event short-circuits inside\n`matchPrintersAndJobs` and the auto-matcher does not assign jobs. The\nqueue page surfaces a \"Match queue now\" button that bypasses this gate\nby passing `manual: true` to the matcher. Defaults to true so existing\nstores keep their current behaviour." }, "currency": { "$ref": "#/components/schemas/FieldOperators" }, "currencySymbol": { "$ref": "#/components/schemas/FieldOperators" }, "defaultPrinterUserProfileId": { "$ref": "#/components/schemas/FieldOperators" }, "defaultPrinterSystemProfileId": { "$ref": "#/components/schemas/FieldOperators" }, "defaultProcessUserProfileId": { "$ref": "#/components/schemas/FieldOperators" }, "defaultProcessSystemProfileId": { "$ref": "#/components/schemas/FieldOperators" }, "defaultFallbackFilamentUserProfileId": { "$ref": "#/components/schemas/FieldOperators" }, "defaultFallbackFilamentSystemProfileId": { "$ref": "#/components/schemas/FieldOperators" }, "experimentalFeatures": { "$ref": "#/components/schemas/FieldOperators" }, "generalSettings": { "$ref": "#/components/schemas/FieldOperators" } }, "title": "Field Condition", "description": "Field-based filter conditions where keys are field names and values are field operators" }, "Material": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "brand": { "type": "string", "minLength": 1 }, "type": { "type": "string" }, "identifier": { "oneOf": [ { "type": "null" }, { "type": "string", "minLength": 1, "maxLength": 8 } ] }, "tags": { "type": "array", "items": { "type": "string" } }, "filamentUserProfileId": { "oneOf": [ { "type": "null" }, { "type": "string", "pattern": "^[a-z0-9]{24}$" } ] }, "filamentSystemProfileId": { "oneOf": [ { "type": "null" }, { "type": "number" } ] }, "starred": { "type": "boolean" }, "pricePer1000g": { "oneOf": [ { "type": "null" }, { "type": "number" } ] }, "source": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "externalId": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "id": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "storeId": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "name", "brand", "type", "tags", "filamentUserProfileId", "filamentSystemProfileId", "id", "storeId", "createdAt", "updatedAt" ], "description": "Material entity representing a general filament material" }, "namestringundefinedbrandstringundefinedtypestringundefinedidentifierstringundefinedtagsstringundefinedfilamentUserProfileIdstringundefined...8more...updatedAtstringundefinedQuerySettings...": { "type": "object", "properties": { "name": { "type": "string" }, "brand": { "type": "string" }, "type": { "type": "string" }, "identifier": { "type": "string" }, "tags": { "type": "string" }, "filamentUserProfileId": { "type": "string" }, "filamentSystemProfileId": { "type": "string" }, "starred": { "type": "string" }, "pricePer1000g": { "type": "string" }, "source": { "type": "string" }, "externalId": { "type": "string" }, "id": { "type": "string" }, "storeId": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "sort": { "type": "string", "title": "Sort", "description": "Sort specification in format \"field:asc,field2:desc\"" }, "limit": { "type": "number", "minimum": 1, "maximum": 1000, "title": "Limit", "description": "Maximum number of results to return (default: 100, max: 1000)" }, "offset": { "type": "number", "minimum": 0, "title": "Offset", "description": "Number of results to skip for pagination" }, "fields": { "type": "string", "title": "Fields", "description": "Comma-separated list of fields to return" }, "include": { "type": "string", "title": "Include", "description": "Comma-separated list of relations to include (max 4, max 2 levels deep).\nExample: \"linkedParts,linkedParts.part,folder\"" }, "meta": { "type": "boolean", "title": "Meta", "description": "If true, returns response with metadata (total, count, hasMore, etc.)" }, "hints": { "type": "boolean", "title": "Hints", "description": "If true, returns AI-friendly hints about available actions. Implies meta=true." } } }, "SearchQueryDtoMaterial": { "type": "object", "properties": { "filter": { "oneOf": [ { "$ref": "#/components/schemas/LogicalConditionMaterial" }, { "$ref": "#/components/schemas/FieldConditionMaterial" } ], "title": "Filter", "description": "Complex filter conditions using logical and field operators.\nAvailable field operators: eq, ne, gt, gte, lt, lte, contains, startsWith, endsWith, in, notIn, isNull, between.\nUsage example: {\"filter\": {\"and\": [{\"name\": {\"contains\": \"benchy\"}}, {\"or\": [{\"type\": {\"eq\": \"3mf\"}}, {\"type\": {\"eq\": \"gcode3mf\"}}]}}}" }, "sort": { "type": "string", "title": "Sort", "description": "Sort specification in format \"field:asc,field2:desc\"" }, "limit": { "type": "number", "minimum": 1, "maximum": 1000, "title": "Limit", "description": "Maximum number of results to return (default: 100, max: 1000)" }, "offset": { "type": "number", "minimum": 0, "title": "Offset", "description": "Number of results to skip for pagination" }, "fields": { "type": "string", "title": "Fields", "description": "Comma-separated list of fields to return" }, "include": { "type": "string", "title": "Include", "description": "Comma-separated list of relations to include (max 4, max 2 levels deep).\nExample: \"linkedParts,linkedParts.part,folder\"" }, "meta": { "type": "boolean", "title": "Meta", "description": "If true, returns response with metadata (total, count, hasMore, etc.)" }, "hints": { "type": "boolean", "title": "Hints", "description": "If true, returns AI-friendly hints about available actions. Implies meta=true." } }, "title": "Search Query", "description": "Complete search request with filter conditions and query settings" }, "LogicalConditionMaterial": { "type": "object", "properties": { "and": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/LogicalConditionMaterial" }, { "$ref": "#/components/schemas/FieldConditionMaterial" } ] }, "title": "AND Conditions", "description": "All conditions must be true" }, "or": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/LogicalConditionMaterial" }, { "$ref": "#/components/schemas/FieldConditionMaterial" } ] }, "title": "OR Conditions", "description": "At least one condition must be true" } }, "title": "Logical Condition", "description": "Logical operators for combining multiple filter conditions" }, "FieldConditionMaterial": { "type": "object", "properties": { "name": { "$ref": "#/components/schemas/FieldOperators" }, "brand": { "$ref": "#/components/schemas/FieldOperators" }, "type": { "$ref": "#/components/schemas/FieldOperators" }, "identifier": { "$ref": "#/components/schemas/FieldOperators" }, "tags": { "$ref": "#/components/schemas/FieldOperators" }, "filamentUserProfileId": { "$ref": "#/components/schemas/FieldOperators" }, "filamentSystemProfileId": { "$ref": "#/components/schemas/FieldOperators" }, "starred": { "$ref": "#/components/schemas/FieldOperators" }, "pricePer1000g": { "$ref": "#/components/schemas/FieldOperators" }, "source": { "$ref": "#/components/schemas/FieldOperators" }, "externalId": { "$ref": "#/components/schemas/FieldOperators" }, "id": { "$ref": "#/components/schemas/FieldOperators" }, "storeId": { "$ref": "#/components/schemas/FieldOperators" }, "createdAt": { "$ref": "#/components/schemas/FieldOperators" }, "updatedAt": { "$ref": "#/components/schemas/FieldOperators" } }, "title": "Field Condition", "description": "Field-based filter conditions where keys are field names and values are field operators" }, "MaterialsData": { "type": "object", "properties": { "materials": { "type": "array", "items": { "$ref": "#/components/schemas/Material" } }, "variants": { "type": "array", "items": { "$ref": "#/components/schemas/MaterialVariant" } }, "groups": { "type": "array", "items": { "$ref": "#/components/schemas/MaterialGroup" } }, "groupMembers": { "type": "array", "items": { "$ref": "#/components/schemas/MaterialGroupMember" } } }, "required": [ "materials", "variants", "groups", "groupMembers" ] }, "MaterialVariant": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "materialId": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "color": { "oneOf": [ { "type": "null" }, { "type": "string", "pattern": "^#([A-Fa-f0-9]{8})(;#([A-Fa-f0-9]{8}))*$" } ] }, "tags": { "type": "array", "items": { "type": "string" } }, "filamentUserProfileId": { "oneOf": [ { "type": "null" }, { "type": "string", "pattern": "^[a-z0-9]{24}$" } ] }, "filamentSystemProfileId": { "oneOf": [ { "type": "null" }, { "type": "number" } ] }, "pricePer1000g": { "oneOf": [ { "type": "null" }, { "type": "number" } ] }, "pressureAdvance": { "oneOf": [ { "type": "null" }, { "type": "number" } ] }, "source": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "externalId": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "id": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "storeId": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "name", "materialId", "color", "tags", "filamentUserProfileId", "filamentSystemProfileId", "id", "storeId", "createdAt", "updatedAt" ], "description": "Material variant representing a specific filament material" }, "MaterialGroup": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "priority": { "type": "number", "minimum": 0 }, "parentId": { "oneOf": [ { "type": "null" }, { "type": "string", "pattern": "^[a-z0-9]{24}$" } ] }, "id": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "storeId": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "name", "priority", "parentId", "id", "storeId", "createdAt", "updatedAt" ], "description": "Material group entity for organizing materials" }, "MaterialGroupMember": { "type": "object", "properties": { "variantId": { "oneOf": [ { "type": "null" }, { "type": "string", "pattern": "^[a-z0-9]{24}$" } ] }, "materialId": { "oneOf": [ { "type": "null" }, { "type": "string", "pattern": "^[a-z0-9]{24}$" } ] }, "materialGroupId": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "materialType": { "type": "string" }, "priority": { "type": "number", "minimum": 0 }, "id": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "storeId": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "variantId", "materialId", "materialGroupId", "materialType", "priority", "id", "storeId", "createdAt", "updatedAt" ], "description": "Material group membership linking materials to groups" }, "MaterialInsert": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "type": { "type": "string" }, "externalId": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "brand": { "type": "string", "minLength": 1 }, "source": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "tags": { "type": "array", "items": { "type": "string" } }, "filamentUserProfileId": { "oneOf": [ { "type": "null" }, { "type": "string", "pattern": "^[a-z0-9]{24}$" } ] }, "filamentSystemProfileId": { "oneOf": [ { "type": "null" }, { "type": "number" } ] }, "identifier": { "oneOf": [ { "type": "null" }, { "type": "string", "minLength": 1, "maxLength": 8 } ] }, "starred": { "type": "boolean" }, "pricePer1000g": { "oneOf": [ { "type": "null" }, { "type": "number" } ] } }, "required": [ "name", "type", "brand", "tags", "filamentUserProfileId", "filamentSystemProfileId" ] }, "MaterialVariantInsert": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "externalId": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "source": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "tags": { "type": "array", "items": { "type": "string" } }, "filamentUserProfileId": { "oneOf": [ { "type": "null" }, { "type": "string", "pattern": "^[a-z0-9]{24}$" } ] }, "filamentSystemProfileId": { "oneOf": [ { "type": "null" }, { "type": "number" } ] }, "pricePer1000g": { "oneOf": [ { "type": "null" }, { "type": "number" } ] }, "materialId": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "color": { "oneOf": [ { "type": "null" }, { "type": "string", "pattern": "^#([A-Fa-f0-9]{8})(;#([A-Fa-f0-9]{8}))*$" } ] }, "pressureAdvance": { "oneOf": [ { "type": "null" }, { "type": "number" } ] } }, "required": [ "name", "tags", "filamentUserProfileId", "filamentSystemProfileId", "materialId", "color" ] }, "PartialMaterialVariant": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "materialId": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "color": { "oneOf": [ { "type": "null" }, { "type": "string", "pattern": "^#([A-Fa-f0-9]{8})(;#([A-Fa-f0-9]{8}))*$" } ] }, "tags": { "type": "array", "items": { "type": "string" } }, "filamentUserProfileId": { "oneOf": [ { "type": "null" }, { "type": "string", "pattern": "^[a-z0-9]{24}$" } ] }, "filamentSystemProfileId": { "oneOf": [ { "type": "null" }, { "type": "number" } ] }, "pricePer1000g": { "oneOf": [ { "type": "null" }, { "type": "number" } ] }, "pressureAdvance": { "oneOf": [ { "type": "null" }, { "type": "number" } ] }, "source": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "externalId": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "id": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "storeId": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "description": "Make all properties in T optional" }, "MaterialGroupInsert": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "parentId": { "oneOf": [ { "type": "null" }, { "type": "string", "pattern": "^[a-z0-9]{24}$" } ] }, "priority": { "type": "number", "minimum": 0 } }, "required": [ "name", "parentId", "priority" ] }, "PartialMaterialGroup": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "priority": { "type": "number", "minimum": 0 }, "parentId": { "oneOf": [ { "type": "null" }, { "type": "string", "pattern": "^[a-z0-9]{24}$" } ] }, "id": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "storeId": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "description": "Make all properties in T optional" }, "MaterialGroupMemberInsert": { "type": "object", "properties": { "priority": { "type": "number", "minimum": 0 }, "materialId": { "oneOf": [ { "type": "null" }, { "type": "string", "pattern": "^[a-z0-9]{24}$" } ] }, "variantId": { "oneOf": [ { "type": "null" }, { "type": "string", "pattern": "^[a-z0-9]{24}$" } ] }, "materialGroupId": { "type": "string", "pattern": "^[a-z0-9]{24}$" } }, "required": [ "priority", "materialId", "variantId", "materialGroupId" ] }, "MaterialInstance": { "type": "object", "properties": { "variantId": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "materialId": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "materialType": { "type": "string" }, "remainingMaterial": { "type": "number", "minimum": 0 }, "source": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "externalId": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "id": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "storeId": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "variantId", "materialId", "materialType", "remainingMaterial", "id", "storeId", "createdAt", "updatedAt" ], "description": "Material instance representing physical spools or cartridges of material" }, "MaterialInstanceInsert": { "type": "object", "properties": { "externalId": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "source": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "materialId": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "variantId": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "materialType": { "type": "string" }, "remainingMaterial": { "type": "number", "minimum": 0 } }, "required": [ "materialId", "variantId", "materialType", "remainingMaterial" ] }, "PartialMaterialInstance": { "type": "object", "properties": { "variantId": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "materialId": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "materialType": { "type": "string" }, "remainingMaterial": { "type": "number", "minimum": 0 }, "source": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "externalId": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "id": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "storeId": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "description": "Make all properties in T optional" }, "printerIdsCuid2visualSlotsVisualSlotsetOnPrinterbooleanundefinedmaterialTypestringfilamentUserProfileIdCuid2nullundefinedfilamentSystemProfileIdnumber...1more...undefinedvariantIdnullundefinedmaterialIdnullundefinedinstanceIdnullundefined...": { "type": "object", "properties": { "printerIds": { "type": "array", "items": { "type": "string", "pattern": "^[a-z0-9]{24}$" } }, "visualSlots": { "type": "array", "items": { "$ref": "#/components/schemas/VisualSlot" } }, "setOnPrinter": { "type": "boolean" }, "materialType": { "type": "string" }, "filamentUserProfileId": { "oneOf": [ { "type": "null" }, { "type": "string", "pattern": "^[a-z0-9]{24}$" } ] }, "filamentSystemProfileId": { "oneOf": [ { "type": "null" }, { "type": "number" } ] }, "variantId": { "type": "null" }, "materialId": { "type": "null" }, "instanceId": { "type": "null" } }, "required": [ "printerIds", "visualSlots", "materialType" ] }, "VisualSlot": { "type": "object", "properties": { "amsIndex": { "type": "number" }, "slotIndex": { "type": "number" } }, "required": [ "amsIndex", "slotIndex" ], "description": "Visual slot position - represents what the user selected in the UI.\namsIndex: -1 for spool, 0+ for AMS array index\nslotIndex: slot within AMS, or spool index for multiple spools" }, "printerIdsCuid2visualSlotsVisualSlotsetOnPrinterbooleanundefinedinstanceIdCuid2filamentUserProfileIdCuid2nullundefinedfilamentSystemProfileIdnumber...1more...undefinedvariantIdnullundefinedmaterialIdnullundefinedmaterialTypenullundefined": { "type": "object", "properties": { "printerIds": { "type": "array", "items": { "type": "string", "pattern": "^[a-z0-9]{24}$" } }, "visualSlots": { "type": "array", "items": { "$ref": "#/components/schemas/VisualSlot" } }, "setOnPrinter": { "type": "boolean" }, "instanceId": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "filamentUserProfileId": { "oneOf": [ { "type": "null" }, { "type": "string", "pattern": "^[a-z0-9]{24}$" } ] }, "filamentSystemProfileId": { "oneOf": [ { "type": "null" }, { "type": "number" } ] }, "variantId": { "type": "null" }, "materialId": { "type": "null" }, "materialType": { "type": "null" } }, "required": [ "printerIds", "visualSlots", "instanceId" ] }, "printerIdsCuid2visualSlotsVisualSlotsetOnPrinterbooleanundefinedvariantIdCuid2filamentUserProfileIdCuid2nullundefinedfilamentSystemProfileIdnumber...1more...undefinedinstanceIdnullundefinedmaterialIdnullundefinedmaterialTypenullundefined": { "type": "object", "properties": { "printerIds": { "type": "array", "items": { "type": "string", "pattern": "^[a-z0-9]{24}$" } }, "visualSlots": { "type": "array", "items": { "$ref": "#/components/schemas/VisualSlot" } }, "setOnPrinter": { "type": "boolean" }, "variantId": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "filamentUserProfileId": { "oneOf": [ { "type": "null" }, { "type": "string", "pattern": "^[a-z0-9]{24}$" } ] }, "filamentSystemProfileId": { "oneOf": [ { "type": "null" }, { "type": "number" } ] }, "instanceId": { "type": "null" }, "materialId": { "type": "null" }, "materialType": { "type": "null" } }, "required": [ "printerIds", "visualSlots", "variantId" ] }, "printerIdsCuid2visualSlotsVisualSlotsetOnPrinterbooleanundefinedmaterialIdCuid2filamentUserProfileIdCuid2nullundefinedfilamentSystemProfileIdnumber...1more...undefinedinstanceIdnullundefinedvariantIdnullundefinedmaterialTypenullundefined": { "type": "object", "properties": { "printerIds": { "type": "array", "items": { "type": "string", "pattern": "^[a-z0-9]{24}$" } }, "visualSlots": { "type": "array", "items": { "$ref": "#/components/schemas/VisualSlot" } }, "setOnPrinter": { "type": "boolean" }, "materialId": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "filamentUserProfileId": { "oneOf": [ { "type": "null" }, { "type": "string", "pattern": "^[a-z0-9]{24}$" } ] }, "filamentSystemProfileId": { "oneOf": [ { "type": "null" }, { "type": "number" } ] }, "instanceId": { "type": "null" }, "variantId": { "type": "null" }, "materialType": { "type": "null" } }, "required": [ "printerIds", "visualSlots", "materialId" ] }, "MaterialProfileAssignment": { "type": "object", "properties": { "modelId": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "nozzleDiameter": { "type": "string" }, "materialId": { "oneOf": [ { "type": "null" }, { "type": "string", "pattern": "^[a-z0-9]{24}$" } ] }, "variantId": { "oneOf": [ { "type": "null" }, { "type": "string", "pattern": "^[a-z0-9]{24}$" } ] }, "userProfileId": { "oneOf": [ { "type": "null" }, { "type": "string", "pattern": "^[a-z0-9]{24}$" } ] }, "systemProfileId": { "oneOf": [ { "type": "null" }, { "type": "number" } ] }, "id": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "storeId": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "modelId", "nozzleDiameter", "materialId", "variantId", "userProfileId", "systemProfileId", "id", "storeId", "createdAt", "updatedAt" ] }, "modelIdstringnozzleDiameterstringuserProfileIdnullundefinedsystemProfileIdnumber": { "type": "object", "properties": { "modelId": { "type": "string" }, "nozzleDiameter": { "type": "string" }, "userProfileId": { "type": "null" }, "systemProfileId": { "type": "number" } }, "required": [ "modelId", "nozzleDiameter", "systemProfileId" ] }, "modelIdstringnozzleDiameterstringuserProfileIdCuid2systemProfileIdnullundefined": { "type": "object", "properties": { "modelId": { "type": "string" }, "nozzleDiameter": { "type": "string" }, "userProfileId": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "systemProfileId": { "type": "null" } }, "required": [ "modelId", "nozzleDiameter", "userProfileId" ] }, "ClearMaterialProfileRequest": { "type": "object", "properties": { "modelId": { "type": "string" }, "nozzleDiameter": { "type": "string" } }, "required": [ "modelId", "nozzleDiameter" ] }, "UpdateMaterialRequest": { "type": "object", "properties": { "name": { "type": "string" }, "brand": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } }, "identifier": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "filamentUserProfileId": { "oneOf": [ { "type": "null" }, { "type": "string", "pattern": "^[a-z0-9]{24}$" } ] }, "filamentSystemProfileId": { "oneOf": [ { "type": "null" }, { "type": "number" } ] }, "starred": { "type": "boolean" } } }, "namestringundefinedmaterialIdstringundefinedcolorstringundefinedtagsstringundefinedfilamentUserProfileIdstringundefinedfilamentSystemProfileIdstringundefined...7more...updatedAtstringundefinedQuerySettings...": { "type": "object", "properties": { "name": { "type": "string" }, "materialId": { "type": "string" }, "color": { "type": "string" }, "tags": { "type": "string" }, "filamentUserProfileId": { "type": "string" }, "filamentSystemProfileId": { "type": "string" }, "pricePer1000g": { "type": "string" }, "pressureAdvance": { "type": "string" }, "source": { "type": "string" }, "externalId": { "type": "string" }, "id": { "type": "string" }, "storeId": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "sort": { "type": "string", "title": "Sort", "description": "Sort specification in format \"field:asc,field2:desc\"" }, "limit": { "type": "number", "minimum": 1, "maximum": 1000, "title": "Limit", "description": "Maximum number of results to return (default: 100, max: 1000)" }, "offset": { "type": "number", "minimum": 0, "title": "Offset", "description": "Number of results to skip for pagination" }, "fields": { "type": "string", "title": "Fields", "description": "Comma-separated list of fields to return" }, "include": { "type": "string", "title": "Include", "description": "Comma-separated list of relations to include (max 4, max 2 levels deep).\nExample: \"linkedParts,linkedParts.part,folder\"" }, "meta": { "type": "boolean", "title": "Meta", "description": "If true, returns response with metadata (total, count, hasMore, etc.)" }, "hints": { "type": "boolean", "title": "Hints", "description": "If true, returns AI-friendly hints about available actions. Implies meta=true." } } }, "SearchQueryDtoMaterialVariant": { "type": "object", "properties": { "filter": { "oneOf": [ { "$ref": "#/components/schemas/LogicalConditionMaterialVariant" }, { "$ref": "#/components/schemas/FieldConditionMaterialVariant" } ], "title": "Filter", "description": "Complex filter conditions using logical and field operators.\nAvailable field operators: eq, ne, gt, gte, lt, lte, contains, startsWith, endsWith, in, notIn, isNull, between.\nUsage example: {\"filter\": {\"and\": [{\"name\": {\"contains\": \"benchy\"}}, {\"or\": [{\"type\": {\"eq\": \"3mf\"}}, {\"type\": {\"eq\": \"gcode3mf\"}}]}}}" }, "sort": { "type": "string", "title": "Sort", "description": "Sort specification in format \"field:asc,field2:desc\"" }, "limit": { "type": "number", "minimum": 1, "maximum": 1000, "title": "Limit", "description": "Maximum number of results to return (default: 100, max: 1000)" }, "offset": { "type": "number", "minimum": 0, "title": "Offset", "description": "Number of results to skip for pagination" }, "fields": { "type": "string", "title": "Fields", "description": "Comma-separated list of fields to return" }, "include": { "type": "string", "title": "Include", "description": "Comma-separated list of relations to include (max 4, max 2 levels deep).\nExample: \"linkedParts,linkedParts.part,folder\"" }, "meta": { "type": "boolean", "title": "Meta", "description": "If true, returns response with metadata (total, count, hasMore, etc.)" }, "hints": { "type": "boolean", "title": "Hints", "description": "If true, returns AI-friendly hints about available actions. Implies meta=true." } }, "title": "Search Query", "description": "Complete search request with filter conditions and query settings" }, "LogicalConditionMaterialVariant": { "type": "object", "properties": { "and": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/LogicalConditionMaterialVariant" }, { "$ref": "#/components/schemas/FieldConditionMaterialVariant" } ] }, "title": "AND Conditions", "description": "All conditions must be true" }, "or": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/LogicalConditionMaterialVariant" }, { "$ref": "#/components/schemas/FieldConditionMaterialVariant" } ] }, "title": "OR Conditions", "description": "At least one condition must be true" } }, "title": "Logical Condition", "description": "Logical operators for combining multiple filter conditions" }, "FieldConditionMaterialVariant": { "type": "object", "properties": { "name": { "$ref": "#/components/schemas/FieldOperators" }, "materialId": { "$ref": "#/components/schemas/FieldOperators" }, "color": { "$ref": "#/components/schemas/FieldOperators" }, "tags": { "$ref": "#/components/schemas/FieldOperators" }, "filamentUserProfileId": { "$ref": "#/components/schemas/FieldOperators" }, "filamentSystemProfileId": { "$ref": "#/components/schemas/FieldOperators" }, "pricePer1000g": { "$ref": "#/components/schemas/FieldOperators" }, "pressureAdvance": { "$ref": "#/components/schemas/FieldOperators" }, "source": { "$ref": "#/components/schemas/FieldOperators" }, "externalId": { "$ref": "#/components/schemas/FieldOperators" }, "id": { "$ref": "#/components/schemas/FieldOperators" }, "storeId": { "$ref": "#/components/schemas/FieldOperators" }, "createdAt": { "$ref": "#/components/schemas/FieldOperators" }, "updatedAt": { "$ref": "#/components/schemas/FieldOperators" } }, "title": "Field Condition", "description": "Field-based filter conditions where keys are field names and values are field operators" }, "modelIdstringundefinednozzleDiameterstringundefinedmaterialIdstringundefinedvariantIdstringundefineduserProfileIdstringundefinedsystemProfileIdstringundefinedidstringundefinedstoreIdstringundefinedcreatedAtstringundefinedupdatedAtstringu...": { "type": "object", "properties": { "modelId": { "type": "string" }, "nozzleDiameter": { "type": "string" }, "materialId": { "type": "string" }, "variantId": { "type": "string" }, "userProfileId": { "type": "string" }, "systemProfileId": { "type": "string" }, "id": { "type": "string" }, "storeId": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "sort": { "type": "string", "title": "Sort", "description": "Sort specification in format \"field:asc,field2:desc\"" }, "limit": { "type": "number", "minimum": 1, "maximum": 1000, "title": "Limit", "description": "Maximum number of results to return (default: 100, max: 1000)" }, "offset": { "type": "number", "minimum": 0, "title": "Offset", "description": "Number of results to skip for pagination" }, "fields": { "type": "string", "title": "Fields", "description": "Comma-separated list of fields to return" }, "include": { "type": "string", "title": "Include", "description": "Comma-separated list of relations to include (max 4, max 2 levels deep).\nExample: \"linkedParts,linkedParts.part,folder\"" }, "meta": { "type": "boolean", "title": "Meta", "description": "If true, returns response with metadata (total, count, hasMore, etc.)" }, "hints": { "type": "boolean", "title": "Hints", "description": "If true, returns AI-friendly hints about available actions. Implies meta=true." } } }, "SearchQueryDtoMaterialProfileAssignment": { "type": "object", "properties": { "filter": { "oneOf": [ { "$ref": "#/components/schemas/LogicalConditionMaterialProfileAssignment" }, { "$ref": "#/components/schemas/FieldConditionMaterialProfileAssignment" } ], "title": "Filter", "description": "Complex filter conditions using logical and field operators.\nAvailable field operators: eq, ne, gt, gte, lt, lte, contains, startsWith, endsWith, in, notIn, isNull, between.\nUsage example: {\"filter\": {\"and\": [{\"name\": {\"contains\": \"benchy\"}}, {\"or\": [{\"type\": {\"eq\": \"3mf\"}}, {\"type\": {\"eq\": \"gcode3mf\"}}]}}}" }, "sort": { "type": "string", "title": "Sort", "description": "Sort specification in format \"field:asc,field2:desc\"" }, "limit": { "type": "number", "minimum": 1, "maximum": 1000, "title": "Limit", "description": "Maximum number of results to return (default: 100, max: 1000)" }, "offset": { "type": "number", "minimum": 0, "title": "Offset", "description": "Number of results to skip for pagination" }, "fields": { "type": "string", "title": "Fields", "description": "Comma-separated list of fields to return" }, "include": { "type": "string", "title": "Include", "description": "Comma-separated list of relations to include (max 4, max 2 levels deep).\nExample: \"linkedParts,linkedParts.part,folder\"" }, "meta": { "type": "boolean", "title": "Meta", "description": "If true, returns response with metadata (total, count, hasMore, etc.)" }, "hints": { "type": "boolean", "title": "Hints", "description": "If true, returns AI-friendly hints about available actions. Implies meta=true." } }, "title": "Search Query", "description": "Complete search request with filter conditions and query settings" }, "LogicalConditionMaterialProfileAssignment": { "type": "object", "properties": { "and": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/LogicalConditionMaterialProfileAssignment" }, { "$ref": "#/components/schemas/FieldConditionMaterialProfileAssignment" } ] }, "title": "AND Conditions", "description": "All conditions must be true" }, "or": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/LogicalConditionMaterialProfileAssignment" }, { "$ref": "#/components/schemas/FieldConditionMaterialProfileAssignment" } ] }, "title": "OR Conditions", "description": "At least one condition must be true" } }, "title": "Logical Condition", "description": "Logical operators for combining multiple filter conditions" }, "FieldConditionMaterialProfileAssignment": { "type": "object", "properties": { "modelId": { "$ref": "#/components/schemas/FieldOperators" }, "nozzleDiameter": { "$ref": "#/components/schemas/FieldOperators" }, "materialId": { "$ref": "#/components/schemas/FieldOperators" }, "variantId": { "$ref": "#/components/schemas/FieldOperators" }, "userProfileId": { "$ref": "#/components/schemas/FieldOperators" }, "systemProfileId": { "$ref": "#/components/schemas/FieldOperators" }, "id": { "$ref": "#/components/schemas/FieldOperators" }, "storeId": { "$ref": "#/components/schemas/FieldOperators" }, "createdAt": { "$ref": "#/components/schemas/FieldOperators" }, "updatedAt": { "$ref": "#/components/schemas/FieldOperators" } }, "title": "Field Condition", "description": "Field-based filter conditions where keys are field names and values are field operators" }, "printerIdstringundefinedmaterialIdstringundefinedvariantIdstringundefinedinstanceIdstringundefinedmaterialTypestringundefinedexpectedDatastringundefined...9more...updatedAtstringundefinedQuerySettings...": { "type": "object", "properties": { "printerId": { "type": "string" }, "materialId": { "type": "string" }, "variantId": { "type": "string" }, "instanceId": { "type": "string" }, "materialType": { "type": "string" }, "expectedData": { "type": "string" }, "expectedDataSetAt": { "type": "string" }, "amsIndex": { "type": "string", "description": "Visual slot position: -1 for spool, 0+ for AMS array index" }, "slotIndex": { "type": "string", "description": "Slot within AMS, or spool index for multiple spools" }, "slot": { "type": "string", "deprecated": true }, "filamentUserProfileId": { "type": "string" }, "filamentSystemProfileId": { "type": "string" }, "id": { "type": "string" }, "storeId": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "sort": { "type": "string", "title": "Sort", "description": "Sort specification in format \"field:asc,field2:desc\"" }, "limit": { "type": "number", "minimum": 1, "maximum": 1000, "title": "Limit", "description": "Maximum number of results to return (default: 100, max: 1000)" }, "offset": { "type": "number", "minimum": 0, "title": "Offset", "description": "Number of results to skip for pagination" }, "fields": { "type": "string", "title": "Fields", "description": "Comma-separated list of fields to return" }, "include": { "type": "string", "title": "Include", "description": "Comma-separated list of relations to include (max 4, max 2 levels deep).\nExample: \"linkedParts,linkedParts.part,folder\"" }, "meta": { "type": "boolean", "title": "Meta", "description": "If true, returns response with metadata (total, count, hasMore, etc.)" }, "hints": { "type": "boolean", "title": "Hints", "description": "If true, returns AI-friendly hints about available actions. Implies meta=true." } } }, "SearchQueryDtoPrinterSlot": { "type": "object", "properties": { "filter": { "oneOf": [ { "$ref": "#/components/schemas/LogicalConditionPrinterSlot" }, { "$ref": "#/components/schemas/FieldConditionPrinterSlot" } ], "title": "Filter", "description": "Complex filter conditions using logical and field operators.\nAvailable field operators: eq, ne, gt, gte, lt, lte, contains, startsWith, endsWith, in, notIn, isNull, between.\nUsage example: {\"filter\": {\"and\": [{\"name\": {\"contains\": \"benchy\"}}, {\"or\": [{\"type\": {\"eq\": \"3mf\"}}, {\"type\": {\"eq\": \"gcode3mf\"}}]}}}" }, "sort": { "type": "string", "title": "Sort", "description": "Sort specification in format \"field:asc,field2:desc\"" }, "limit": { "type": "number", "minimum": 1, "maximum": 1000, "title": "Limit", "description": "Maximum number of results to return (default: 100, max: 1000)" }, "offset": { "type": "number", "minimum": 0, "title": "Offset", "description": "Number of results to skip for pagination" }, "fields": { "type": "string", "title": "Fields", "description": "Comma-separated list of fields to return" }, "include": { "type": "string", "title": "Include", "description": "Comma-separated list of relations to include (max 4, max 2 levels deep).\nExample: \"linkedParts,linkedParts.part,folder\"" }, "meta": { "type": "boolean", "title": "Meta", "description": "If true, returns response with metadata (total, count, hasMore, etc.)" }, "hints": { "type": "boolean", "title": "Hints", "description": "If true, returns AI-friendly hints about available actions. Implies meta=true." } }, "title": "Search Query", "description": "Complete search request with filter conditions and query settings" }, "LogicalConditionPrinterSlot": { "type": "object", "properties": { "and": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/LogicalConditionPrinterSlot" }, { "$ref": "#/components/schemas/FieldConditionPrinterSlot" } ] }, "title": "AND Conditions", "description": "All conditions must be true" }, "or": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/LogicalConditionPrinterSlot" }, { "$ref": "#/components/schemas/FieldConditionPrinterSlot" } ] }, "title": "OR Conditions", "description": "At least one condition must be true" } }, "title": "Logical Condition", "description": "Logical operators for combining multiple filter conditions" }, "FieldConditionPrinterSlot": { "type": "object", "properties": { "printerId": { "$ref": "#/components/schemas/FieldOperators" }, "materialId": { "$ref": "#/components/schemas/FieldOperators" }, "variantId": { "$ref": "#/components/schemas/FieldOperators" }, "instanceId": { "$ref": "#/components/schemas/FieldOperators" }, "materialType": { "$ref": "#/components/schemas/FieldOperators" }, "expectedData": { "$ref": "#/components/schemas/FieldOperators" }, "expectedDataSetAt": { "$ref": "#/components/schemas/FieldOperators" }, "amsIndex": { "$ref": "#/components/schemas/FieldOperators", "description": "Visual slot position: -1 for spool, 0+ for AMS array index" }, "slotIndex": { "$ref": "#/components/schemas/FieldOperators", "description": "Slot within AMS, or spool index for multiple spools" }, "slot": { "$ref": "#/components/schemas/FieldOperators", "deprecated": true }, "filamentUserProfileId": { "$ref": "#/components/schemas/FieldOperators" }, "filamentSystemProfileId": { "$ref": "#/components/schemas/FieldOperators" }, "id": { "$ref": "#/components/schemas/FieldOperators" }, "storeId": { "$ref": "#/components/schemas/FieldOperators" }, "createdAt": { "$ref": "#/components/schemas/FieldOperators" }, "updatedAt": { "$ref": "#/components/schemas/FieldOperators" } }, "title": "Field Condition", "description": "Field-based filter conditions where keys are field names and values are field operators" }, "idstringundefinedstoreIdstringundefinedcreatedAtstringundefinedupdatedAtstringundefinedgroupIdstringundefinedvariantIdstringundefined...4more...prioritystringundefinedQuerySettings...": { "type": "object", "properties": { "id": { "type": "string" }, "storeId": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "groupId": { "type": "string" }, "variantId": { "type": "string" }, "materialId": { "type": "string" }, "materialType": { "type": "string" }, "partId": { "type": "string" }, "index": { "type": "string" }, "priority": { "type": "string" }, "sort": { "type": "string", "title": "Sort", "description": "Sort specification in format \"field:asc,field2:desc\"" }, "limit": { "type": "number", "minimum": 1, "maximum": 1000, "title": "Limit", "description": "Maximum number of results to return (default: 100, max: 1000)" }, "offset": { "type": "number", "minimum": 0, "title": "Offset", "description": "Number of results to skip for pagination" }, "fields": { "type": "string", "title": "Fields", "description": "Comma-separated list of fields to return" }, "include": { "type": "string", "title": "Include", "description": "Comma-separated list of relations to include (max 4, max 2 levels deep).\nExample: \"linkedParts,linkedParts.part,folder\"" }, "meta": { "type": "boolean", "title": "Meta", "description": "If true, returns response with metadata (total, count, hasMore, etc.)" }, "hints": { "type": "boolean", "title": "Hints", "description": "If true, returns AI-friendly hints about available actions. Implies meta=true." } } }, "SearchQueryDtoPartMaterialAssignment": { "type": "object", "properties": { "filter": { "oneOf": [ { "$ref": "#/components/schemas/LogicalConditionPartMaterialAssignment" }, { "$ref": "#/components/schemas/FieldConditionPartMaterialAssignment" } ], "title": "Filter", "description": "Complex filter conditions using logical and field operators.\nAvailable field operators: eq, ne, gt, gte, lt, lte, contains, startsWith, endsWith, in, notIn, isNull, between.\nUsage example: {\"filter\": {\"and\": [{\"name\": {\"contains\": \"benchy\"}}, {\"or\": [{\"type\": {\"eq\": \"3mf\"}}, {\"type\": {\"eq\": \"gcode3mf\"}}]}}}" }, "sort": { "type": "string", "title": "Sort", "description": "Sort specification in format \"field:asc,field2:desc\"" }, "limit": { "type": "number", "minimum": 1, "maximum": 1000, "title": "Limit", "description": "Maximum number of results to return (default: 100, max: 1000)" }, "offset": { "type": "number", "minimum": 0, "title": "Offset", "description": "Number of results to skip for pagination" }, "fields": { "type": "string", "title": "Fields", "description": "Comma-separated list of fields to return" }, "include": { "type": "string", "title": "Include", "description": "Comma-separated list of relations to include (max 4, max 2 levels deep).\nExample: \"linkedParts,linkedParts.part,folder\"" }, "meta": { "type": "boolean", "title": "Meta", "description": "If true, returns response with metadata (total, count, hasMore, etc.)" }, "hints": { "type": "boolean", "title": "Hints", "description": "If true, returns AI-friendly hints about available actions. Implies meta=true." } }, "title": "Search Query", "description": "Complete search request with filter conditions and query settings" }, "LogicalConditionPartMaterialAssignment": { "type": "object", "properties": { "and": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/LogicalConditionPartMaterialAssignment" }, { "$ref": "#/components/schemas/FieldConditionPartMaterialAssignment" } ] }, "title": "AND Conditions", "description": "All conditions must be true" }, "or": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/LogicalConditionPartMaterialAssignment" }, { "$ref": "#/components/schemas/FieldConditionPartMaterialAssignment" } ] }, "title": "OR Conditions", "description": "At least one condition must be true" } }, "title": "Logical Condition", "description": "Logical operators for combining multiple filter conditions" }, "FieldConditionPartMaterialAssignment": { "type": "object", "properties": { "id": { "$ref": "#/components/schemas/FieldOperators" }, "storeId": { "$ref": "#/components/schemas/FieldOperators" }, "createdAt": { "$ref": "#/components/schemas/FieldOperators" }, "updatedAt": { "$ref": "#/components/schemas/FieldOperators" }, "groupId": { "$ref": "#/components/schemas/FieldOperators" }, "variantId": { "$ref": "#/components/schemas/FieldOperators" }, "materialId": { "$ref": "#/components/schemas/FieldOperators" }, "materialType": { "$ref": "#/components/schemas/FieldOperators" }, "partId": { "$ref": "#/components/schemas/FieldOperators" }, "index": { "$ref": "#/components/schemas/FieldOperators" }, "priority": { "$ref": "#/components/schemas/FieldOperators" } }, "title": "Field Condition", "description": "Field-based filter conditions where keys are field names and values are field operators" }, "PartMetadata": { "type": "object", "properties": { "partId": { "type": "string" }, "metadata3mf": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/Metadata3MF" } ] }, "slicingEstimate": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/SlicingEstimate" } ] }, "inputHash": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "storeId": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "updatedAt": { "type": "string", "format": "date-time" }, "createdAt": { "type": "string", "format": "date-time" } }, "required": [ "partId", "metadata3mf", "slicingEstimate", "inputHash", "storeId", "updatedAt", "createdAt" ] }, "SkuOptionValue": { "type": "object", "properties": { "name": { "type": "string" }, "optionId": { "oneOf": [ { "type": "null" }, { "type": "string", "pattern": "^[a-z0-9]{24}$" } ] }, "skuSuffixes": { "oneOf": [ { "type": "null" }, { "type": "array", "items": { "type": "string" } } ] }, "order": { "type": "number" }, "id": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "storeId": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "name", "optionId", "order", "id", "storeId", "createdAt", "updatedAt" ] }, "CreateSkuOptionValueRequest": { "type": "object", "properties": { "name": { "type": "string" }, "optionId": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "skuSuffixes": { "type": "array", "items": { "type": "string" } } }, "required": [ "name", "optionId" ] }, "UpdateSkuOptionValueRequest": { "type": "object", "properties": { "name": { "type": "string" }, "skuSuffixes": { "type": "array", "items": { "type": "string" } } } }, "ReorderSkuOptionValueRequest": { "type": "object", "properties": { "optionValueId": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "newOrder": { "type": "number" } }, "required": [ "optionValueId", "newOrder" ] }, "SkuOptionProperty": { "type": "object", "properties": { "optionId": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "bindingId": { "oneOf": [ { "type": "null" }, { "type": "string", "pattern": "^[a-z0-9]{24}$" } ] }, "bindingId2": { "oneOf": [ { "type": "null" }, { "type": "string", "pattern": "^[a-z0-9]{24}$" } ] }, "bindingId3": { "oneOf": [ { "type": "null" }, { "type": "string", "pattern": "^[a-z0-9]{24}$" } ] }, "name": { "type": "string" }, "type": { "oneOf": [ { "const": "text" }, { "const": "material" }, { "const": "plate_quantities" } ] }, "order": { "type": "number" }, "id": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "storeId": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "optionId", "name", "type", "order", "id", "storeId", "createdAt", "updatedAt" ] }, "CreateSkuOptionPropertyRequest": { "type": "object", "properties": { "optionId": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "bindingId": { "oneOf": [ { "type": "null" }, { "type": "string", "pattern": "^[a-z0-9]{24}$" } ], "description": "For local properties: primary source binding (null = global property)" }, "bindingId2": { "oneOf": [ { "type": "null" }, { "type": "string", "pattern": "^[a-z0-9]{24}$" } ], "description": "For compound local properties: 2nd source binding" }, "bindingId3": { "oneOf": [ { "type": "null" }, { "type": "string", "pattern": "^[a-z0-9]{24}$" } ], "description": "For compound local properties: 3rd source binding" }, "name": { "type": "string" }, "type": { "oneOf": [ { "const": "text" }, { "const": "material" }, { "const": "plate_quantities" } ] } }, "required": [ "optionId", "name", "type" ] }, "UpdateSkuOptionPropertyRequest": { "type": "object", "properties": { "name": { "type": "string" } } }, "ReorderSkuOptionPropertyRequest": { "type": "object", "properties": { "propertyId": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "newOrder": { "type": "number" } }, "required": [ "propertyId", "newOrder" ] }, "SkuOptionPropertyValue": { "type": "object", "properties": { "propertyId": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "optionValueId": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "optionValueId2": { "oneOf": [ { "type": "null" }, { "type": "string", "pattern": "^[a-z0-9]{24}$" } ] }, "optionValueId3": { "oneOf": [ { "type": "null" }, { "type": "string", "pattern": "^[a-z0-9]{24}$" } ] }, "textValue": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "materialValue": { "oneOf": [ { "type": "null" }, { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "groupId": { "type": "string", "pattern": "^[a-z0-9]{24}$" } }, "required": [ "groupId" ] }, { "type": "object", "properties": { "variantId": { "type": "string", "pattern": "^[a-z0-9]{24}$" } }, "required": [ "variantId" ] }, { "type": "object", "properties": { "materialId": { "type": "string", "pattern": "^[a-z0-9]{24}$" } }, "required": [ "materialId" ] }, { "type": "object", "properties": { "materialType": { "type": "string" } }, "required": [ "materialType" ] } ] } } ] }, "plateQuantitiesValue": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/Recordstringnumber" } ] }, "id": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "storeId": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "propertyId", "optionValueId", "id", "storeId", "createdAt", "updatedAt" ] }, "BulkCreatePropertyValuesRequest": { "type": "object", "properties": { "values": { "type": "array", "items": { "$ref": "#/components/schemas/CreateSkuOptionPropertyValueRequest" } } }, "required": [ "values" ] }, "CreateSkuOptionPropertyValueRequest": { "type": "object", "properties": { "optionValueId": { "type": "string", "pattern": "^[a-z0-9]{24}$", "description": "Value from bindingId's option (always required)" }, "optionValueId2": { "oneOf": [ { "type": "null" }, { "type": "string", "pattern": "^[a-z0-9]{24}$" } ], "description": "Value from bindingId2's option (required if property has bindingId2)" }, "optionValueId3": { "oneOf": [ { "type": "null" }, { "type": "string", "pattern": "^[a-z0-9]{24}$" } ], "description": "Value from bindingId3's option (required if property has bindingId3)" }, "propertyId": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "textValue": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "materialValue": { "oneOf": [ { "type": "null" }, { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "groupId": { "type": "string", "pattern": "^[a-z0-9]{24}$" } }, "required": [ "groupId" ] }, { "type": "object", "properties": { "variantId": { "type": "string", "pattern": "^[a-z0-9]{24}$" } }, "required": [ "variantId" ] }, { "type": "object", "properties": { "materialId": { "type": "string", "pattern": "^[a-z0-9]{24}$" } }, "required": [ "materialId" ] }, { "type": "object", "properties": { "materialType": { "type": "string" } }, "required": [ "materialType" ] } ] } } ] }, "plateQuantitiesValue": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/Recordstringnumber" } ] } }, "required": [ "optionValueId", "propertyId" ] }, "BulkUpdatePropertyValuesRequest": { "type": "object", "properties": { "updates": { "type": "array", "items": { "$ref": "#/components/schemas/UpdateSkuOptionPropertyValueRequest" } } }, "required": [ "updates" ] }, "UpdateSkuOptionPropertyValueRequest": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "textValue": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "materialValue": { "oneOf": [ { "type": "null" }, { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "groupId": { "type": "string", "pattern": "^[a-z0-9]{24}$" } }, "required": [ "groupId" ] }, { "type": "object", "properties": { "variantId": { "type": "string", "pattern": "^[a-z0-9]{24}$" } }, "required": [ "variantId" ] }, { "type": "object", "properties": { "materialId": { "type": "string", "pattern": "^[a-z0-9]{24}$" } }, "required": [ "materialId" ] }, { "type": "object", "properties": { "materialType": { "type": "string" } }, "required": [ "materialType" ] } ] } } ] }, "plateQuantitiesValue": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/Recordstringnumber" } ] } }, "required": [ "id" ] }, "BulkDeleteRequest": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "pattern": "^[a-z0-9]{24}$" } } }, "required": [ "ids" ] }, "SkuOption": { "type": "object", "properties": { "name": { "type": "string" }, "isPersonalization": { "type": "boolean" }, "id": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "storeId": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "name", "isPersonalization", "id", "storeId", "createdAt", "updatedAt" ] }, "namestringundefinedisPersonalizationstringundefinedidstringundefinedstoreIdstringundefinedcreatedAtstringundefinedupdatedAtstringundefinedQuerySettings...": { "type": "object", "properties": { "name": { "type": "string" }, "isPersonalization": { "type": "string" }, "id": { "type": "string" }, "storeId": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "sort": { "type": "string", "title": "Sort", "description": "Sort specification in format \"field:asc,field2:desc\"" }, "limit": { "type": "number", "minimum": 1, "maximum": 1000, "title": "Limit", "description": "Maximum number of results to return (default: 100, max: 1000)" }, "offset": { "type": "number", "minimum": 0, "title": "Offset", "description": "Number of results to skip for pagination" }, "fields": { "type": "string", "title": "Fields", "description": "Comma-separated list of fields to return" }, "include": { "type": "string", "title": "Include", "description": "Comma-separated list of relations to include (max 4, max 2 levels deep).\nExample: \"linkedParts,linkedParts.part,folder\"" }, "meta": { "type": "boolean", "title": "Meta", "description": "If true, returns response with metadata (total, count, hasMore, etc.)" }, "hints": { "type": "boolean", "title": "Hints", "description": "If true, returns AI-friendly hints about available actions. Implies meta=true." } } }, "SearchQueryDtoSkuOption": { "type": "object", "properties": { "filter": { "oneOf": [ { "$ref": "#/components/schemas/LogicalConditionSkuOption" }, { "$ref": "#/components/schemas/FieldConditionSkuOption" } ], "title": "Filter", "description": "Complex filter conditions using logical and field operators.\nAvailable field operators: eq, ne, gt, gte, lt, lte, contains, startsWith, endsWith, in, notIn, isNull, between.\nUsage example: {\"filter\": {\"and\": [{\"name\": {\"contains\": \"benchy\"}}, {\"or\": [{\"type\": {\"eq\": \"3mf\"}}, {\"type\": {\"eq\": \"gcode3mf\"}}]}}}" }, "sort": { "type": "string", "title": "Sort", "description": "Sort specification in format \"field:asc,field2:desc\"" }, "limit": { "type": "number", "minimum": 1, "maximum": 1000, "title": "Limit", "description": "Maximum number of results to return (default: 100, max: 1000)" }, "offset": { "type": "number", "minimum": 0, "title": "Offset", "description": "Number of results to skip for pagination" }, "fields": { "type": "string", "title": "Fields", "description": "Comma-separated list of fields to return" }, "include": { "type": "string", "title": "Include", "description": "Comma-separated list of relations to include (max 4, max 2 levels deep).\nExample: \"linkedParts,linkedParts.part,folder\"" }, "meta": { "type": "boolean", "title": "Meta", "description": "If true, returns response with metadata (total, count, hasMore, etc.)" }, "hints": { "type": "boolean", "title": "Hints", "description": "If true, returns AI-friendly hints about available actions. Implies meta=true." } }, "title": "Search Query", "description": "Complete search request with filter conditions and query settings" }, "LogicalConditionSkuOption": { "type": "object", "properties": { "and": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/LogicalConditionSkuOption" }, { "$ref": "#/components/schemas/FieldConditionSkuOption" } ] }, "title": "AND Conditions", "description": "All conditions must be true" }, "or": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/LogicalConditionSkuOption" }, { "$ref": "#/components/schemas/FieldConditionSkuOption" } ] }, "title": "OR Conditions", "description": "At least one condition must be true" } }, "title": "Logical Condition", "description": "Logical operators for combining multiple filter conditions" }, "FieldConditionSkuOption": { "type": "object", "properties": { "name": { "$ref": "#/components/schemas/FieldOperators" }, "isPersonalization": { "$ref": "#/components/schemas/FieldOperators" }, "id": { "$ref": "#/components/schemas/FieldOperators" }, "storeId": { "$ref": "#/components/schemas/FieldOperators" }, "createdAt": { "$ref": "#/components/schemas/FieldOperators" }, "updatedAt": { "$ref": "#/components/schemas/FieldOperators" } }, "title": "Field Condition", "description": "Field-based filter conditions where keys are field names and values are field operators" }, "SkuOptionBinding": { "type": "object", "properties": { "optionId": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "skuId": { "type": "string" }, "order": { "type": "number" }, "filterMode": { "oneOf": [ { "type": "null" }, { "const": "inclusion" }, { "const": "exclusion" } ] }, "id": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "storeId": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "optionId", "skuId", "order", "filterMode", "id", "storeId", "createdAt", "updatedAt" ] }, "CreateSkuOptionBindingRequest": { "type": "object", "properties": { "optionId": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "skuId": { "type": "string", "pattern": "^[a-z0-9]{24}$" } }, "required": [ "optionId", "skuId" ] }, "UpdateSkuOptionBindingRequest": { "type": "object", "properties": { "optionId": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "skuId": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "order": { "type": "number" }, "filterMode": { "oneOf": [ { "type": "null" }, { "const": "inclusion" }, { "const": "exclusion" } ] } } }, "ReorderSkuOptionBindingRequest": { "type": "object", "properties": { "bindingId": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "newOrder": { "type": "number" } }, "required": [ "bindingId", "newOrder" ] }, "CreateSkuOptionRequest": { "type": "object", "properties": { "name": { "type": "string" }, "isPersonalization": { "type": "boolean" } }, "required": [ "name", "isPersonalization" ] }, "UpdateSkuOptionRequest": { "type": "object", "properties": { "name": { "type": "string" } } }, "SkuOptionValueFilter": { "type": "object", "properties": { "bindingId": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "skuId": { "type": "string" }, "optionId": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "optionValueId": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "id": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "storeId": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "bindingId", "skuId", "optionId", "optionValueId", "id", "storeId", "createdAt", "updatedAt" ] }, "SetFilteredValuesRequest": { "type": "object", "properties": { "skuId": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "optionId": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "valueIds": { "type": "array", "items": { "type": "string", "pattern": "^[a-z0-9]{24}$" } }, "filterMode": { "oneOf": [ { "type": "null" }, { "const": "inclusion" }, { "const": "exclusion" } ] } }, "required": [ "skuId", "optionId", "valueIds", "filterMode" ] }, "SkuMatchResult": { "type": "object", "properties": { "skuId": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "sku": { "type": "string" }, "options": { "type": "array", "items": { "$ref": "#/components/schemas/SkuMatchOptionResult" } } }, "required": [ "skuId", "sku", "options" ] }, "SkuMatchOptionResult": { "type": "object", "properties": { "optionId": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "optionName": { "type": "string" }, "value": { "type": "string" }, "valueId": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "suffix": { "type": "string" } }, "required": [ "optionId", "optionName", "value", "valueId", "suffix" ] }, "CostComponent": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "unit": { "type": "string" }, "rate": { "type": "number" }, "type": { "oneOf": [ { "const": "material" }, { "const": "labor" }, { "const": "overhead" } ] }, "description": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "storeId": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "id", "name", "unit", "rate", "type", "storeId", "createdAt", "updatedAt" ] }, "idstringundefinednamestringundefinedunitstringundefinedratestringundefinedtypestringundefineddescriptionstringundefinedstoreIdstringundefinedcreatedAtstringundefinedupdatedAtstringundefinedQuerySettings...": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "unit": { "type": "string" }, "rate": { "type": "string" }, "type": { "type": "string" }, "description": { "type": "string" }, "storeId": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "sort": { "type": "string", "title": "Sort", "description": "Sort specification in format \"field:asc,field2:desc\"" }, "limit": { "type": "number", "minimum": 1, "maximum": 1000, "title": "Limit", "description": "Maximum number of results to return (default: 100, max: 1000)" }, "offset": { "type": "number", "minimum": 0, "title": "Offset", "description": "Number of results to skip for pagination" }, "fields": { "type": "string", "title": "Fields", "description": "Comma-separated list of fields to return" }, "include": { "type": "string", "title": "Include", "description": "Comma-separated list of relations to include (max 4, max 2 levels deep).\nExample: \"linkedParts,linkedParts.part,folder\"" }, "meta": { "type": "boolean", "title": "Meta", "description": "If true, returns response with metadata (total, count, hasMore, etc.)" }, "hints": { "type": "boolean", "title": "Hints", "description": "If true, returns AI-friendly hints about available actions. Implies meta=true." } } }, "SearchQueryDtoCostComponent": { "type": "object", "properties": { "filter": { "oneOf": [ { "$ref": "#/components/schemas/LogicalConditionCostComponent" }, { "$ref": "#/components/schemas/FieldConditionCostComponent" } ], "title": "Filter", "description": "Complex filter conditions using logical and field operators.\nAvailable field operators: eq, ne, gt, gte, lt, lte, contains, startsWith, endsWith, in, notIn, isNull, between.\nUsage example: {\"filter\": {\"and\": [{\"name\": {\"contains\": \"benchy\"}}, {\"or\": [{\"type\": {\"eq\": \"3mf\"}}, {\"type\": {\"eq\": \"gcode3mf\"}}]}}}" }, "sort": { "type": "string", "title": "Sort", "description": "Sort specification in format \"field:asc,field2:desc\"" }, "limit": { "type": "number", "minimum": 1, "maximum": 1000, "title": "Limit", "description": "Maximum number of results to return (default: 100, max: 1000)" }, "offset": { "type": "number", "minimum": 0, "title": "Offset", "description": "Number of results to skip for pagination" }, "fields": { "type": "string", "title": "Fields", "description": "Comma-separated list of fields to return" }, "include": { "type": "string", "title": "Include", "description": "Comma-separated list of relations to include (max 4, max 2 levels deep).\nExample: \"linkedParts,linkedParts.part,folder\"" }, "meta": { "type": "boolean", "title": "Meta", "description": "If true, returns response with metadata (total, count, hasMore, etc.)" }, "hints": { "type": "boolean", "title": "Hints", "description": "If true, returns AI-friendly hints about available actions. Implies meta=true." } }, "title": "Search Query", "description": "Complete search request with filter conditions and query settings" }, "LogicalConditionCostComponent": { "type": "object", "properties": { "and": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/LogicalConditionCostComponent" }, { "$ref": "#/components/schemas/FieldConditionCostComponent" } ] }, "title": "AND Conditions", "description": "All conditions must be true" }, "or": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/LogicalConditionCostComponent" }, { "$ref": "#/components/schemas/FieldConditionCostComponent" } ] }, "title": "OR Conditions", "description": "At least one condition must be true" } }, "title": "Logical Condition", "description": "Logical operators for combining multiple filter conditions" }, "FieldConditionCostComponent": { "type": "object", "properties": { "id": { "$ref": "#/components/schemas/FieldOperators" }, "name": { "$ref": "#/components/schemas/FieldOperators" }, "unit": { "$ref": "#/components/schemas/FieldOperators" }, "rate": { "$ref": "#/components/schemas/FieldOperators" }, "type": { "$ref": "#/components/schemas/FieldOperators" }, "description": { "$ref": "#/components/schemas/FieldOperators" }, "storeId": { "$ref": "#/components/schemas/FieldOperators" }, "createdAt": { "$ref": "#/components/schemas/FieldOperators" }, "updatedAt": { "$ref": "#/components/schemas/FieldOperators" } }, "title": "Field Condition", "description": "Field-based filter conditions where keys are field names and values are field operators" }, "Partial__type.o12": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "oneOf": [ { "const": "material" }, { "const": "labor" }, { "const": "overhead" } ] }, "unit": { "type": "string" }, "rate": { "type": "number" }, "id": { "type": "string" }, "storeId": { "type": "string" }, "updatedAt": { "type": "string", "format": "date-time" }, "createdAt": { "type": "string", "format": "date-time" }, "description": { "oneOf": [ { "type": "null" }, { "type": "string" } ] } }, "description": "Make all properties in T optional" }, "SkuCost": { "type": "object", "properties": { "id": { "type": "string" }, "skuId": { "type": "string" }, "costComponentId": { "type": "string" }, "quantity": { "type": "number" }, "storeId": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "id", "skuId", "costComponentId", "quantity", "storeId", "createdAt", "updatedAt" ] }, "idstringundefinedskuIdstringundefinedcostComponentIdstringundefinedquantitystringundefinedstoreIdstringundefinedcreatedAtstringundefinedupdatedAtstringundefinedQuerySettings...": { "type": "object", "properties": { "id": { "type": "string" }, "skuId": { "type": "string" }, "costComponentId": { "type": "string" }, "quantity": { "type": "string" }, "storeId": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "sort": { "type": "string", "title": "Sort", "description": "Sort specification in format \"field:asc,field2:desc\"" }, "limit": { "type": "number", "minimum": 1, "maximum": 1000, "title": "Limit", "description": "Maximum number of results to return (default: 100, max: 1000)" }, "offset": { "type": "number", "minimum": 0, "title": "Offset", "description": "Number of results to skip for pagination" }, "fields": { "type": "string", "title": "Fields", "description": "Comma-separated list of fields to return" }, "include": { "type": "string", "title": "Include", "description": "Comma-separated list of relations to include (max 4, max 2 levels deep).\nExample: \"linkedParts,linkedParts.part,folder\"" }, "meta": { "type": "boolean", "title": "Meta", "description": "If true, returns response with metadata (total, count, hasMore, etc.)" }, "hints": { "type": "boolean", "title": "Hints", "description": "If true, returns AI-friendly hints about available actions. Implies meta=true." } } }, "SearchQueryDtoSkuCost": { "type": "object", "properties": { "filter": { "oneOf": [ { "$ref": "#/components/schemas/LogicalConditionSkuCost" }, { "$ref": "#/components/schemas/FieldConditionSkuCost" } ], "title": "Filter", "description": "Complex filter conditions using logical and field operators.\nAvailable field operators: eq, ne, gt, gte, lt, lte, contains, startsWith, endsWith, in, notIn, isNull, between.\nUsage example: {\"filter\": {\"and\": [{\"name\": {\"contains\": \"benchy\"}}, {\"or\": [{\"type\": {\"eq\": \"3mf\"}}, {\"type\": {\"eq\": \"gcode3mf\"}}]}}}" }, "sort": { "type": "string", "title": "Sort", "description": "Sort specification in format \"field:asc,field2:desc\"" }, "limit": { "type": "number", "minimum": 1, "maximum": 1000, "title": "Limit", "description": "Maximum number of results to return (default: 100, max: 1000)" }, "offset": { "type": "number", "minimum": 0, "title": "Offset", "description": "Number of results to skip for pagination" }, "fields": { "type": "string", "title": "Fields", "description": "Comma-separated list of fields to return" }, "include": { "type": "string", "title": "Include", "description": "Comma-separated list of relations to include (max 4, max 2 levels deep).\nExample: \"linkedParts,linkedParts.part,folder\"" }, "meta": { "type": "boolean", "title": "Meta", "description": "If true, returns response with metadata (total, count, hasMore, etc.)" }, "hints": { "type": "boolean", "title": "Hints", "description": "If true, returns AI-friendly hints about available actions. Implies meta=true." } }, "title": "Search Query", "description": "Complete search request with filter conditions and query settings" }, "LogicalConditionSkuCost": { "type": "object", "properties": { "and": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/LogicalConditionSkuCost" }, { "$ref": "#/components/schemas/FieldConditionSkuCost" } ] }, "title": "AND Conditions", "description": "All conditions must be true" }, "or": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/LogicalConditionSkuCost" }, { "$ref": "#/components/schemas/FieldConditionSkuCost" } ] }, "title": "OR Conditions", "description": "At least one condition must be true" } }, "title": "Logical Condition", "description": "Logical operators for combining multiple filter conditions" }, "FieldConditionSkuCost": { "type": "object", "properties": { "id": { "$ref": "#/components/schemas/FieldOperators" }, "skuId": { "$ref": "#/components/schemas/FieldOperators" }, "costComponentId": { "$ref": "#/components/schemas/FieldOperators" }, "quantity": { "$ref": "#/components/schemas/FieldOperators" }, "storeId": { "$ref": "#/components/schemas/FieldOperators" }, "createdAt": { "$ref": "#/components/schemas/FieldOperators" }, "updatedAt": { "$ref": "#/components/schemas/FieldOperators" } }, "title": "Field Condition", "description": "Field-based filter conditions where keys are field names and values are field operators" }, "SkuCostWithComponent": { "type": "object", "properties": { "component": { "$ref": "#/components/schemas/CostComponent" }, "id": { "type": "string" }, "skuId": { "type": "string" }, "costComponentId": { "type": "string" }, "quantity": { "type": "number" }, "storeId": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "component", "id", "skuId", "costComponentId", "quantity", "storeId", "createdAt", "updatedAt" ] }, "CostBreakdown": { "type": "object", "properties": { "materials": { "type": "number" }, "labor": { "type": "number" }, "overhead": { "type": "number" }, "total": { "type": "number" } }, "required": [ "materials", "labor", "overhead", "total" ] }, "Partial__type.o13": { "type": "object", "properties": { "skuId": { "type": "string" }, "costComponentId": { "type": "string" }, "id": { "type": "string" }, "storeId": { "type": "string" }, "updatedAt": { "type": "string", "format": "date-time" }, "createdAt": { "type": "string", "format": "date-time" }, "quantity": { "type": "number" } }, "description": "Make all properties in T optional" }, "RecordstringRecordstringApiHint": { "type": "object", "properties": {}, "description": "Construct a type with a set of properties K of type T", "additionalProperties": { "$ref": "#/components/schemas/RecordstringApiHint" } }, "RecordstringApiHint": { "type": "object", "properties": {}, "description": "Construct a type with a set of properties K of type T", "additionalProperties": { "$ref": "#/components/schemas/ApiHint" } }, "ApiHint": { "type": "object", "properties": { "action": { "type": "string", "title": "Action", "description": "Short name of the action" }, "description": { "type": "string", "title": "Description", "description": "Human-readable description of what this action does" }, "method": { "oneOf": [ { "const": "DELETE" }, { "const": "PUT" }, { "const": "POST" }, { "const": "GET" }, { "const": "PATCH" } ], "title": "Method", "description": "HTTP method for this action" }, "path": { "type": "string", "title": "Path", "description": "API path template. Use {id} for entity ID placeholders." }, "bodySchema": { "$ref": "#/components/schemas/Recordstringany", "title": "Body Schema", "description": "Example or schema of the request body (for POST/PATCH)" }, "condition": { "type": "string", "title": "Condition", "description": "When this hint applies (e.g., \"when part has type gcode3mf\")" } }, "required": [ "action", "description", "method", "path" ], "title": "API Hint", "description": "A hint for AI agents about available actions" }, "object": { "type": "object", "properties": {} }, "Recordstringunknown": { "type": "object", "properties": {}, "description": "Construct a type with a set of properties K of type T", "additionalProperties": {} }, "FieldChange": { "type": "object", "properties": { "field": { "type": "string" }, "oldValue": {}, "newValue": {} }, "required": [ "field", "oldValue", "newValue" ], "description": "Represents a change to a single field in an entity." }, "sourcestringundefinedmetadatastringundefinedidstringundefinedstoreIdstringundefinedcreatedAtstringundefinedentityTypestringundefined...13more...reasonstringundefinedQuerySettings...": { "type": "object", "properties": { "source": { "type": "string" }, "metadata": { "type": "string" }, "id": { "type": "string" }, "storeId": { "type": "string" }, "createdAt": { "type": "string" }, "entityType": { "type": "string" }, "entityId": { "type": "string" }, "entityIds": { "type": "string" }, "action": { "type": "string" }, "detailedAction": { "type": "string" }, "changes": { "type": "string" }, "actorId": { "type": "string" }, "actorType": { "type": "string" }, "actorEmail": { "type": "string" }, "apiKeyId": { "type": "string" }, "impersonatedBy": { "type": "string" }, "correlationId": { "type": "string" }, "ipAddress": { "type": "string" }, "userAgent": { "type": "string" }, "reason": { "type": "string" }, "sort": { "type": "string", "title": "Sort", "description": "Sort specification in format \"field:asc,field2:desc\"" }, "limit": { "type": "number", "minimum": 1, "maximum": 1000, "title": "Limit", "description": "Maximum number of results to return (default: 100, max: 1000)" }, "offset": { "type": "number", "minimum": 0, "title": "Offset", "description": "Number of results to skip for pagination" }, "fields": { "type": "string", "title": "Fields", "description": "Comma-separated list of fields to return" }, "include": { "type": "string", "title": "Include", "description": "Comma-separated list of relations to include (max 4, max 2 levels deep).\nExample: \"linkedParts,linkedParts.part,folder\"" }, "meta": { "type": "boolean", "title": "Meta", "description": "If true, returns response with metadata (total, count, hasMore, etc.)" }, "hints": { "type": "boolean", "title": "Hints", "description": "If true, returns AI-friendly hints about available actions. Implies meta=true." }, "entityIdSearch": { "type": "string" } } }, "SearchQueryDto__type": { "type": "object", "properties": { "filter": { "oneOf": [ { "$ref": "#/components/schemas/LogicalCondition__type" }, { "$ref": "#/components/schemas/FieldCondition__type" } ], "title": "Filter", "description": "Complex filter conditions using logical and field operators.\nAvailable field operators: eq, ne, gt, gte, lt, lte, contains, startsWith, endsWith, in, notIn, isNull, between.\nUsage example: {\"filter\": {\"and\": [{\"name\": {\"contains\": \"benchy\"}}, {\"or\": [{\"type\": {\"eq\": \"3mf\"}}, {\"type\": {\"eq\": \"gcode3mf\"}}]}}}" }, "sort": { "type": "string", "title": "Sort", "description": "Sort specification in format \"field:asc,field2:desc\"" }, "limit": { "type": "number", "minimum": 1, "maximum": 1000, "title": "Limit", "description": "Maximum number of results to return (default: 100, max: 1000)" }, "offset": { "type": "number", "minimum": 0, "title": "Offset", "description": "Number of results to skip for pagination" }, "fields": { "type": "string", "title": "Fields", "description": "Comma-separated list of fields to return" }, "include": { "type": "string", "title": "Include", "description": "Comma-separated list of relations to include (max 4, max 2 levels deep).\nExample: \"linkedParts,linkedParts.part,folder\"" }, "meta": { "type": "boolean", "title": "Meta", "description": "If true, returns response with metadata (total, count, hasMore, etc.)" }, "hints": { "type": "boolean", "title": "Hints", "description": "If true, returns AI-friendly hints about available actions. Implies meta=true." } }, "title": "Search Query", "description": "Complete search request with filter conditions and query settings" }, "LogicalCondition__type": { "type": "object", "properties": { "and": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/LogicalCondition__type" }, { "$ref": "#/components/schemas/FieldCondition__type" } ] }, "title": "AND Conditions", "description": "All conditions must be true" }, "or": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/LogicalCondition__type" }, { "$ref": "#/components/schemas/FieldCondition__type" } ] }, "title": "OR Conditions", "description": "At least one condition must be true" } }, "title": "Logical Condition", "description": "Logical operators for combining multiple filter conditions" }, "FieldCondition__type": { "type": "object", "properties": { "source": { "$ref": "#/components/schemas/FieldOperators" }, "metadata": { "$ref": "#/components/schemas/FieldOperators" }, "id": { "$ref": "#/components/schemas/FieldOperators" }, "storeId": { "$ref": "#/components/schemas/FieldOperators" }, "createdAt": { "$ref": "#/components/schemas/FieldOperators" }, "entityType": { "$ref": "#/components/schemas/FieldOperators" }, "entityId": { "$ref": "#/components/schemas/FieldOperators" }, "entityIds": { "$ref": "#/components/schemas/FieldOperators" }, "action": { "$ref": "#/components/schemas/FieldOperators" }, "detailedAction": { "$ref": "#/components/schemas/FieldOperators" }, "changes": { "$ref": "#/components/schemas/FieldOperators" }, "actorId": { "$ref": "#/components/schemas/FieldOperators" }, "actorType": { "$ref": "#/components/schemas/FieldOperators" }, "actorEmail": { "$ref": "#/components/schemas/FieldOperators" }, "apiKeyId": { "$ref": "#/components/schemas/FieldOperators" }, "impersonatedBy": { "$ref": "#/components/schemas/FieldOperators" }, "correlationId": { "$ref": "#/components/schemas/FieldOperators" }, "ipAddress": { "$ref": "#/components/schemas/FieldOperators" }, "userAgent": { "$ref": "#/components/schemas/FieldOperators" }, "reason": { "$ref": "#/components/schemas/FieldOperators" } }, "title": "Field Condition", "description": "Field-based filter conditions where keys are field names and values are field operators" }, "GetUserSettingsResponse": { "type": "object", "properties": { "defaultStoreId": { "oneOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": [ "defaultStoreId" ] }, "UpdateUserSettingsRequest": { "type": "object", "properties": { "defaultStoreId": { "oneOf": [ { "type": "null" }, { "type": "string" } ] } } }, "MaintenanceItem": { "type": "object", "properties": { "name": { "type": "string" }, "triggerType": { "oneOf": [ { "const": "print_hours" }, { "const": "calendar_days" }, { "const": "job_count" } ] }, "interval": { "type": "number" }, "warningThresholdPct": { "type": "number" }, "notes": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "isSystemDefault": { "type": "boolean" }, "id": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "storeId": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "name", "triggerType", "interval", "warningThresholdPct", "notes", "isSystemDefault", "id", "storeId", "createdAt", "updatedAt" ] }, "MaintenanceItemInsert": { "type": "object", "properties": { "name": { "type": "string" }, "triggerType": { "oneOf": [ { "const": "print_hours" }, { "const": "calendar_days" }, { "const": "job_count" } ] }, "interval": { "type": "number" }, "warningThresholdPct": { "type": "number" }, "notes": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "isSystemDefault": { "type": "boolean" } }, "required": [ "name", "triggerType", "interval", "warningThresholdPct", "notes", "isSystemDefault" ] }, "PartialPickMaintenanceItemnametriggerTypeintervalwarningThresholdPctnotes": { "type": "object", "properties": { "name": { "type": "string" }, "triggerType": { "oneOf": [ { "const": "print_hours" }, { "const": "calendar_days" }, { "const": "job_count" } ] }, "interval": { "type": "number" }, "warningThresholdPct": { "type": "number" }, "notes": { "oneOf": [ { "type": "null" }, { "type": "string" } ] } }, "description": "Make all properties in T optional" }, "MaintenanceStatusInfo": { "type": "object", "properties": { "enrollmentId": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "printerId": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "maintenanceItemId": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "printerName": { "type": "string" }, "itemName": { "type": "string" }, "triggerType": { "oneOf": [ { "const": "print_hours" }, { "const": "calendar_days" }, { "const": "job_count" } ] }, "interval": { "type": "number" }, "elapsed": { "type": "number" }, "progress": { "type": "number" }, "status": { "oneOf": [ { "const": "OK" }, { "const": "DUE_SOON" }, { "const": "OVERDUE" } ] }, "warningThresholdPct": { "type": "number" }, "lastCompletedAt": { "oneOf": [ { "type": "null" }, { "type": "string", "format": "date-time" } ] }, "lastCompletedBy": { "oneOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": [ "enrollmentId", "printerId", "maintenanceItemId", "printerName", "itemName", "triggerType", "interval", "elapsed", "progress", "status", "warningThresholdPct", "lastCompletedAt", "lastCompletedBy" ], "description": "Runtime-computed status — never stored in the database" }, "PrinterMaintenanceEnrollment": { "type": "object", "properties": { "printerId": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "maintenanceItemId": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "currentOffset": { "type": "number" }, "hoursAtLastCompletion": { "oneOf": [ { "type": "null" }, { "type": "number" } ] }, "jobsAtLastCompletion": { "oneOf": [ { "type": "null" }, { "type": "number" } ] }, "lastCompletedAt": { "oneOf": [ { "type": "null" }, { "type": "string", "format": "date-time" } ] }, "lastCompletedBy": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "lastNotifiedStatus": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "id": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "storeId": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "printerId", "maintenanceItemId", "currentOffset", "hoursAtLastCompletion", "jobsAtLastCompletion", "lastCompletedAt", "lastCompletedBy", "lastNotifiedStatus", "id", "storeId", "createdAt", "updatedAt" ] }, "MaintenanceCompletionLog": { "type": "object", "properties": { "enrollmentId": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "printerId": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "maintenanceItemId": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "completedAt": { "type": "string", "format": "date-time" }, "completedBy": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "hoursAtCompletion": { "oneOf": [ { "type": "null" }, { "type": "number" } ] }, "jobsAtCompletion": { "oneOf": [ { "type": "null" }, { "type": "number" } ] }, "notes": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "id": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "storeId": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "enrollmentId", "printerId", "maintenanceItemId", "completedAt", "completedBy", "hoursAtCompletion", "jobsAtCompletion", "notes", "id", "storeId", "createdAt", "updatedAt" ] }, "RecordstringRecordstringnumber": { "type": "object", "properties": {}, "description": "Construct a type with a set of properties K of type T", "additionalProperties": { "$ref": "#/components/schemas/Recordstringnumber" } }, "ApiKey": { "type": "object", "properties": { "hash": { "type": "string" }, "salt": { "type": "string" }, "name": { "type": "string" }, "active": { "type": "boolean" }, "managed": { "type": "boolean" }, "managedBy": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "externalRef": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "integrationId": { "oneOf": [ { "type": "null" }, { "type": "string", "pattern": "^[a-z0-9]{24}$" } ], "description": "Optional link to integration - when integration is deleted, this API key is also deleted" }, "fullAccess": { "type": "boolean" }, "ipAllowlist": { "oneOf": [ { "type": "null" }, { "type": "array", "items": { "type": "string" } } ] }, "createdBy": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "lastUsedAt": { "oneOf": [ { "type": "null" }, { "type": "string", "format": "date-time" } ] }, "expiresAt": { "oneOf": [ { "type": "null" }, { "type": "string", "format": "date-time" } ] }, "id": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "storeId": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "hash", "salt", "name", "active", "managed", "fullAccess", "id", "storeId", "createdAt", "updatedAt" ] }, "hashstringundefinedsaltstringundefinednamestringundefinedactivestringundefinedmanagedstringundefinedmanagedBystringundefinedexternalRefstringundefined...9more...updatedAtstringundefinedQuerySettings...": { "type": "object", "properties": { "hash": { "type": "string" }, "salt": { "type": "string" }, "name": { "type": "string" }, "active": { "type": "string" }, "managed": { "type": "string" }, "managedBy": { "type": "string" }, "externalRef": { "type": "string" }, "integrationId": { "type": "string", "description": "Optional link to integration - when integration is deleted, this API key is also deleted" }, "fullAccess": { "type": "string" }, "ipAllowlist": { "type": "string" }, "createdBy": { "type": "string" }, "lastUsedAt": { "type": "string" }, "expiresAt": { "type": "string" }, "id": { "type": "string" }, "storeId": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "sort": { "type": "string", "title": "Sort", "description": "Sort specification in format \"field:asc,field2:desc\"" }, "limit": { "type": "number", "minimum": 1, "maximum": 1000, "title": "Limit", "description": "Maximum number of results to return (default: 100, max: 1000)" }, "offset": { "type": "number", "minimum": 0, "title": "Offset", "description": "Number of results to skip for pagination" }, "fields": { "type": "string", "title": "Fields", "description": "Comma-separated list of fields to return" }, "include": { "type": "string", "title": "Include", "description": "Comma-separated list of relations to include (max 4, max 2 levels deep).\nExample: \"linkedParts,linkedParts.part,folder\"" }, "meta": { "type": "boolean", "title": "Meta", "description": "If true, returns response with metadata (total, count, hasMore, etc.)" }, "hints": { "type": "boolean", "title": "Hints", "description": "If true, returns AI-friendly hints about available actions. Implies meta=true." } } }, "SearchQueryDtoApiKey": { "type": "object", "properties": { "filter": { "oneOf": [ { "$ref": "#/components/schemas/LogicalConditionApiKey" }, { "$ref": "#/components/schemas/FieldConditionApiKey" } ], "title": "Filter", "description": "Complex filter conditions using logical and field operators.\nAvailable field operators: eq, ne, gt, gte, lt, lte, contains, startsWith, endsWith, in, notIn, isNull, between.\nUsage example: {\"filter\": {\"and\": [{\"name\": {\"contains\": \"benchy\"}}, {\"or\": [{\"type\": {\"eq\": \"3mf\"}}, {\"type\": {\"eq\": \"gcode3mf\"}}]}}}" }, "sort": { "type": "string", "title": "Sort", "description": "Sort specification in format \"field:asc,field2:desc\"" }, "limit": { "type": "number", "minimum": 1, "maximum": 1000, "title": "Limit", "description": "Maximum number of results to return (default: 100, max: 1000)" }, "offset": { "type": "number", "minimum": 0, "title": "Offset", "description": "Number of results to skip for pagination" }, "fields": { "type": "string", "title": "Fields", "description": "Comma-separated list of fields to return" }, "include": { "type": "string", "title": "Include", "description": "Comma-separated list of relations to include (max 4, max 2 levels deep).\nExample: \"linkedParts,linkedParts.part,folder\"" }, "meta": { "type": "boolean", "title": "Meta", "description": "If true, returns response with metadata (total, count, hasMore, etc.)" }, "hints": { "type": "boolean", "title": "Hints", "description": "If true, returns AI-friendly hints about available actions. Implies meta=true." } }, "title": "Search Query", "description": "Complete search request with filter conditions and query settings" }, "LogicalConditionApiKey": { "type": "object", "properties": { "and": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/LogicalConditionApiKey" }, { "$ref": "#/components/schemas/FieldConditionApiKey" } ] }, "title": "AND Conditions", "description": "All conditions must be true" }, "or": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/LogicalConditionApiKey" }, { "$ref": "#/components/schemas/FieldConditionApiKey" } ] }, "title": "OR Conditions", "description": "At least one condition must be true" } }, "title": "Logical Condition", "description": "Logical operators for combining multiple filter conditions" }, "FieldConditionApiKey": { "type": "object", "properties": { "hash": { "$ref": "#/components/schemas/FieldOperators" }, "salt": { "$ref": "#/components/schemas/FieldOperators" }, "name": { "$ref": "#/components/schemas/FieldOperators" }, "active": { "$ref": "#/components/schemas/FieldOperators" }, "managed": { "$ref": "#/components/schemas/FieldOperators" }, "managedBy": { "$ref": "#/components/schemas/FieldOperators" }, "externalRef": { "$ref": "#/components/schemas/FieldOperators" }, "integrationId": { "$ref": "#/components/schemas/FieldOperators", "description": "Optional link to integration - when integration is deleted, this API key is also deleted" }, "fullAccess": { "$ref": "#/components/schemas/FieldOperators" }, "ipAllowlist": { "$ref": "#/components/schemas/FieldOperators" }, "createdBy": { "$ref": "#/components/schemas/FieldOperators" }, "lastUsedAt": { "$ref": "#/components/schemas/FieldOperators" }, "expiresAt": { "$ref": "#/components/schemas/FieldOperators" }, "id": { "$ref": "#/components/schemas/FieldOperators" }, "storeId": { "$ref": "#/components/schemas/FieldOperators" }, "createdAt": { "$ref": "#/components/schemas/FieldOperators" }, "updatedAt": { "$ref": "#/components/schemas/FieldOperators" } }, "title": "Field Condition", "description": "Field-based filter conditions where keys are field names and values are field operators" }, "OneTimeApiKeyInfo": { "type": "object", "properties": { "id": { "type": "string" }, "storeId": { "type": "string" }, "name": { "type": "string" }, "key": { "type": "string" } }, "required": [ "id", "storeId", "name", "key" ] }, "CreateApiKeyRequest": { "type": "object", "properties": { "name": { "type": "string" }, "fullAccess": { "type": "boolean" }, "permissions": { "type": "array", "items": { "oneOf": [ { "const": "organization.owner" }, { "const": "organization.edit" }, { "const": "organization.delete" }, { "const": "user.view" }, { "const": "user.invite" }, { "const": "user.edit" }, { "const": "user.delete" }, { "const": "permission.view" }, { "const": "permission.grant" }, { "const": "permission.revoke" }, { "const": "part.view" }, { "const": "part.create" }, { "const": "part.edit" }, { "const": "part.delete" }, { "const": "part.export" }, { "const": "sku.view" }, { "const": "sku.create" }, { "const": "sku.edit" }, { "const": "sku.delete" }, { "const": "material.view" }, { "const": "material.create" }, { "const": "material.edit" }, { "const": "material.delete" }, { "const": "material.instance.view" }, { "const": "material.instance.create" }, { "const": "material.instance.edit" }, { "const": "material.instance.delete" }, { "const": "printer.view" }, { "const": "printer.create" }, { "const": "printer.edit" }, { "const": "printer.delete" }, { "const": "printer.control" }, { "const": "printer.ready" }, { "const": "printer.config" }, { "const": "printer.stats" }, { "const": "printer.camera" }, { "const": "profile.view" }, { "const": "profile.create" }, { "const": "profile.edit" }, { "const": "profile.delete" }, { "const": "queue.view" }, { "const": "queue.manage" }, { "const": "queue.override" }, { "const": "job.create" }, { "const": "job.edit.own" }, { "const": "job.edit.all" }, { "const": "job.delete.own" }, { "const": "job.delete.all" }, { "const": "build.view" }, { "const": "build.create" }, { "const": "build.edit" }, { "const": "build.delete" }, { "const": "settings.view" }, { "const": "settings.edit" }, { "const": "integration.view" }, { "const": "integration.manage" }, { "const": "subscription.view" }, { "const": "subscription.manage" }, { "const": "analytics.view" }, { "const": "reports.generate" }, { "const": "audit.log.view" }, { "const": "audit.logs.configure" }, { "const": "order.view" }, { "const": "order.create" }, { "const": "order.edit" }, { "const": "order.delete" }, { "const": "order.print" }, { "const": "apiKey.view" }, { "const": "apiKey.create" }, { "const": "apiKey.edit" }, { "const": "apiKey.delete" }, { "const": "file.download" }, { "const": "maintenance.view" }, { "const": "maintenance.create" }, { "const": "maintenance.edit" }, { "const": "maintenance.delete" }, { "const": "maintenance.complete" }, { "const": "internal.shopify" }, { "const": "queue.admin" }, { "const": "part.viewer" }, { "const": "part.editor" }, { "const": "sku.viewer" }, { "const": "sku.editor" }, { "const": "orders.admin" }, { "const": "material.viewer" }, { "const": "material.editor" }, { "const": "printer.viewer" }, { "const": "printer.editor" }, { "const": "profile.viewer" }, { "const": "profile.editor" }, { "const": "settings.admin" }, { "const": "subscription.admin" } ] } }, "roleIds": { "type": "array", "items": { "type": "string" } }, "ipAllowlist": { "type": "array", "items": { "type": "string" } }, "expiresAt": { "type": "string", "format": "date-time" } }, "required": [ "name" ] }, "UpdateApiKeyRequest": { "type": "object", "properties": { "active": { "type": "boolean" }, "name": { "type": "string", "minLength": 1 }, "fullAccess": { "type": "boolean" }, "ipAllowlist": { "oneOf": [ { "type": "null" }, { "type": "array", "items": { "type": "string" } } ] }, "permissions": { "type": "array", "items": { "oneOf": [ { "const": "organization.owner" }, { "const": "organization.edit" }, { "const": "organization.delete" }, { "const": "user.view" }, { "const": "user.invite" }, { "const": "user.edit" }, { "const": "user.delete" }, { "const": "permission.view" }, { "const": "permission.grant" }, { "const": "permission.revoke" }, { "const": "part.view" }, { "const": "part.create" }, { "const": "part.edit" }, { "const": "part.delete" }, { "const": "part.export" }, { "const": "sku.view" }, { "const": "sku.create" }, { "const": "sku.edit" }, { "const": "sku.delete" }, { "const": "material.view" }, { "const": "material.create" }, { "const": "material.edit" }, { "const": "material.delete" }, { "const": "material.instance.view" }, { "const": "material.instance.create" }, { "const": "material.instance.edit" }, { "const": "material.instance.delete" }, { "const": "printer.view" }, { "const": "printer.create" }, { "const": "printer.edit" }, { "const": "printer.delete" }, { "const": "printer.control" }, { "const": "printer.ready" }, { "const": "printer.config" }, { "const": "printer.stats" }, { "const": "printer.camera" }, { "const": "profile.view" }, { "const": "profile.create" }, { "const": "profile.edit" }, { "const": "profile.delete" }, { "const": "queue.view" }, { "const": "queue.manage" }, { "const": "queue.override" }, { "const": "job.create" }, { "const": "job.edit.own" }, { "const": "job.edit.all" }, { "const": "job.delete.own" }, { "const": "job.delete.all" }, { "const": "build.view" }, { "const": "build.create" }, { "const": "build.edit" }, { "const": "build.delete" }, { "const": "settings.view" }, { "const": "settings.edit" }, { "const": "integration.view" }, { "const": "integration.manage" }, { "const": "subscription.view" }, { "const": "subscription.manage" }, { "const": "analytics.view" }, { "const": "reports.generate" }, { "const": "audit.log.view" }, { "const": "audit.logs.configure" }, { "const": "order.view" }, { "const": "order.create" }, { "const": "order.edit" }, { "const": "order.delete" }, { "const": "order.print" }, { "const": "apiKey.view" }, { "const": "apiKey.create" }, { "const": "apiKey.edit" }, { "const": "apiKey.delete" }, { "const": "file.download" }, { "const": "maintenance.view" }, { "const": "maintenance.create" }, { "const": "maintenance.edit" }, { "const": "maintenance.delete" }, { "const": "maintenance.complete" }, { "const": "internal.shopify" }, { "const": "queue.admin" }, { "const": "part.viewer" }, { "const": "part.editor" }, { "const": "sku.viewer" }, { "const": "sku.editor" }, { "const": "orders.admin" }, { "const": "material.viewer" }, { "const": "material.editor" }, { "const": "printer.viewer" }, { "const": "printer.editor" }, { "const": "profile.viewer" }, { "const": "profile.editor" }, { "const": "settings.admin" }, { "const": "subscription.admin" } ] } }, "roleIds": { "type": "array", "items": { "type": "string" } } } }, "Subscription": { "type": "object", "properties": { "concurrencySlots": { "oneOf": [ { "type": "null" }, { "type": "number", "minimum": 1 } ] }, "plan": { "oneOf": [ { "type": "null" }, { "const": "core" }, { "const": "personal" } ] }, "trialEndsAt": { "oneOf": [ { "type": "null" }, { "type": "string", "format": "date-time" } ] }, "term": { "oneOf": [ { "type": "null" }, { "const": "year" }, { "const": "month" } ] }, "isCommercial": { "oneOf": [ { "type": "null" }, { "type": "boolean" } ] }, "id": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "storeId": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "concurrencySlots", "plan", "trialEndsAt", "term", "isCommercial", "id", "storeId", "createdAt", "updatedAt" ] }, "SetAuditLogsEnabledRequest": { "type": "object", "properties": { "enabled": { "type": "boolean" } }, "required": [ "enabled" ] }, "SearchQueryDtoSubscription": { "type": "object", "properties": { "filter": { "oneOf": [ { "$ref": "#/components/schemas/LogicalConditionSubscription" }, { "$ref": "#/components/schemas/FieldConditionSubscription" } ], "title": "Filter", "description": "Complex filter conditions using logical and field operators.\nAvailable field operators: eq, ne, gt, gte, lt, lte, contains, startsWith, endsWith, in, notIn, isNull, between.\nUsage example: {\"filter\": {\"and\": [{\"name\": {\"contains\": \"benchy\"}}, {\"or\": [{\"type\": {\"eq\": \"3mf\"}}, {\"type\": {\"eq\": \"gcode3mf\"}}]}}}" }, "sort": { "type": "string", "title": "Sort", "description": "Sort specification in format \"field:asc,field2:desc\"" }, "limit": { "type": "number", "minimum": 1, "maximum": 1000, "title": "Limit", "description": "Maximum number of results to return (default: 100, max: 1000)" }, "offset": { "type": "number", "minimum": 0, "title": "Offset", "description": "Number of results to skip for pagination" }, "fields": { "type": "string", "title": "Fields", "description": "Comma-separated list of fields to return" }, "include": { "type": "string", "title": "Include", "description": "Comma-separated list of relations to include (max 4, max 2 levels deep).\nExample: \"linkedParts,linkedParts.part,folder\"" }, "meta": { "type": "boolean", "title": "Meta", "description": "If true, returns response with metadata (total, count, hasMore, etc.)" }, "hints": { "type": "boolean", "title": "Hints", "description": "If true, returns AI-friendly hints about available actions. Implies meta=true." } }, "title": "Search Query", "description": "Complete search request with filter conditions and query settings" }, "LogicalConditionSubscription": { "type": "object", "properties": { "and": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/LogicalConditionSubscription" }, { "$ref": "#/components/schemas/FieldConditionSubscription" } ] }, "title": "AND Conditions", "description": "All conditions must be true" }, "or": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/LogicalConditionSubscription" }, { "$ref": "#/components/schemas/FieldConditionSubscription" } ] }, "title": "OR Conditions", "description": "At least one condition must be true" } }, "title": "Logical Condition", "description": "Logical operators for combining multiple filter conditions" }, "FieldConditionSubscription": { "type": "object", "properties": { "concurrencySlots": { "$ref": "#/components/schemas/FieldOperators" }, "plan": { "$ref": "#/components/schemas/FieldOperators" }, "trialEndsAt": { "$ref": "#/components/schemas/FieldOperators" }, "term": { "$ref": "#/components/schemas/FieldOperators" }, "isCommercial": { "$ref": "#/components/schemas/FieldOperators" }, "id": { "$ref": "#/components/schemas/FieldOperators" }, "storeId": { "$ref": "#/components/schemas/FieldOperators" }, "createdAt": { "$ref": "#/components/schemas/FieldOperators" }, "updatedAt": { "$ref": "#/components/schemas/FieldOperators" } }, "title": "Field Condition", "description": "Field-based filter conditions where keys are field names and values are field operators" }, "Addon": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "addonType": { "type": "string" }, "name": { "type": "string" }, "requiresCommercial": { "type": "boolean" }, "isActive": { "type": "boolean" }, "metadata": { "$ref": "#/components/schemas/Recordstringany" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "id", "addonType", "name", "requiresCommercial", "isActive", "metadata", "createdAt", "updatedAt" ] }, "AddonWithTiers": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "addonType": { "type": "string" }, "name": { "type": "string" }, "requiresCommercial": { "type": "boolean" }, "isActive": { "type": "boolean" }, "metadata": { "$ref": "#/components/schemas/Recordstringany" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "tiers": { "type": "array", "items": { "$ref": "#/components/schemas/AddonTier" } } }, "required": [ "id", "addonType", "name", "requiresCommercial", "isActive", "metadata", "createdAt", "updatedAt", "tiers" ] }, "AddonTier": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "addonId": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "tierKey": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "name": { "type": "string" }, "stripePriceIdMonthly": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "stripePriceIdYearly": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "amountMonthly": { "oneOf": [ { "type": "null" }, { "type": "number" } ] }, "amountYearly": { "oneOf": [ { "type": "null" }, { "type": "number" } ] }, "billingType": { "oneOf": [ { "const": "subscription" }, { "const": "usage" } ] }, "stripePriceIdUsage": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "unitPrice": { "oneOf": [ { "type": "null" }, { "type": "number" } ] }, "usageAggregation": { "oneOf": [ { "type": "null" }, { "const": "sum" }, { "const": "last_during_period" }, { "const": "max" } ] }, "displayOrder": { "type": "number" }, "isActive": { "type": "boolean" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "id", "addonId", "tierKey", "name", "stripePriceIdMonthly", "stripePriceIdYearly", "amountMonthly", "amountYearly", "billingType", "stripePriceIdUsage", "unitPrice", "usageAggregation", "displayOrder", "isActive", "createdAt", "updatedAt" ] }, "AddonSubscription": { "type": "object", "properties": { "addonType": { "type": "string" }, "tierKey": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "tierId": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "term": { "oneOf": [ { "const": "year" }, { "const": "month" } ] }, "id": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "storeId": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "addonType", "tierKey", "tierId", "term", "id", "storeId", "createdAt", "updatedAt" ] }, "addonTypestringundefinedtierKeystringundefinedtierIdstringundefinedtermstringundefinedidstringundefinedstoreIdstringundefinedcreatedAtstringundefinedupdatedAtstringundefinedQuerySettings...": { "type": "object", "properties": { "addonType": { "type": "string" }, "tierKey": { "type": "string" }, "tierId": { "type": "string" }, "term": { "type": "string" }, "id": { "type": "string" }, "storeId": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "sort": { "type": "string", "title": "Sort", "description": "Sort specification in format \"field:asc,field2:desc\"" }, "limit": { "type": "number", "minimum": 1, "maximum": 1000, "title": "Limit", "description": "Maximum number of results to return (default: 100, max: 1000)" }, "offset": { "type": "number", "minimum": 0, "title": "Offset", "description": "Number of results to skip for pagination" }, "fields": { "type": "string", "title": "Fields", "description": "Comma-separated list of fields to return" }, "include": { "type": "string", "title": "Include", "description": "Comma-separated list of relations to include (max 4, max 2 levels deep).\nExample: \"linkedParts,linkedParts.part,folder\"" }, "meta": { "type": "boolean", "title": "Meta", "description": "If true, returns response with metadata (total, count, hasMore, etc.)" }, "hints": { "type": "boolean", "title": "Hints", "description": "If true, returns AI-friendly hints about available actions. Implies meta=true." } } }, "SearchQueryDtoAddonSubscription": { "type": "object", "properties": { "filter": { "oneOf": [ { "$ref": "#/components/schemas/LogicalConditionAddonSubscription" }, { "$ref": "#/components/schemas/FieldConditionAddonSubscription" } ], "title": "Filter", "description": "Complex filter conditions using logical and field operators.\nAvailable field operators: eq, ne, gt, gte, lt, lte, contains, startsWith, endsWith, in, notIn, isNull, between.\nUsage example: {\"filter\": {\"and\": [{\"name\": {\"contains\": \"benchy\"}}, {\"or\": [{\"type\": {\"eq\": \"3mf\"}}, {\"type\": {\"eq\": \"gcode3mf\"}}]}}}" }, "sort": { "type": "string", "title": "Sort", "description": "Sort specification in format \"field:asc,field2:desc\"" }, "limit": { "type": "number", "minimum": 1, "maximum": 1000, "title": "Limit", "description": "Maximum number of results to return (default: 100, max: 1000)" }, "offset": { "type": "number", "minimum": 0, "title": "Offset", "description": "Number of results to skip for pagination" }, "fields": { "type": "string", "title": "Fields", "description": "Comma-separated list of fields to return" }, "include": { "type": "string", "title": "Include", "description": "Comma-separated list of relations to include (max 4, max 2 levels deep).\nExample: \"linkedParts,linkedParts.part,folder\"" }, "meta": { "type": "boolean", "title": "Meta", "description": "If true, returns response with metadata (total, count, hasMore, etc.)" }, "hints": { "type": "boolean", "title": "Hints", "description": "If true, returns AI-friendly hints about available actions. Implies meta=true." } }, "title": "Search Query", "description": "Complete search request with filter conditions and query settings" }, "LogicalConditionAddonSubscription": { "type": "object", "properties": { "and": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/LogicalConditionAddonSubscription" }, { "$ref": "#/components/schemas/FieldConditionAddonSubscription" } ] }, "title": "AND Conditions", "description": "All conditions must be true" }, "or": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/LogicalConditionAddonSubscription" }, { "$ref": "#/components/schemas/FieldConditionAddonSubscription" } ] }, "title": "OR Conditions", "description": "At least one condition must be true" } }, "title": "Logical Condition", "description": "Logical operators for combining multiple filter conditions" }, "FieldConditionAddonSubscription": { "type": "object", "properties": { "addonType": { "$ref": "#/components/schemas/FieldOperators" }, "tierKey": { "$ref": "#/components/schemas/FieldOperators" }, "tierId": { "$ref": "#/components/schemas/FieldOperators" }, "term": { "$ref": "#/components/schemas/FieldOperators" }, "id": { "$ref": "#/components/schemas/FieldOperators" }, "storeId": { "$ref": "#/components/schemas/FieldOperators" }, "createdAt": { "$ref": "#/components/schemas/FieldOperators" }, "updatedAt": { "$ref": "#/components/schemas/FieldOperators" } }, "title": "Field Condition", "description": "Field-based filter conditions where keys are field names and values are field operators" }, "SignedUrlsResponse": { "type": "object", "properties": { "signedUrls": { "type": "array", "items": { "type": "string" } } }, "required": [ "signedUrls" ] }, "SignedUrlsRequest": { "type": "object", "properties": { "paths": { "type": "array", "items": { "type": "string" } }, "duration": { "type": "number" } }, "required": [ "paths" ] }, "SignedUploadUrlsResponse": { "type": "object", "properties": { "signedUrls": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "uploadUrl": { "type": "string" }, "method": { "oneOf": [ { "const": "PUT" }, { "const": "POST" } ], "description": "HTTP method to use for the upload. Production GCS signed write URLs are\n'PUT'; the Firebase Storage emulator's REST simple-upload endpoint is\n'POST'. Optional for backwards compatibility — older clients can fall\nback to 'PUT' (or sniff the URL)." } }, "required": [ "path", "uploadUrl" ] } } }, "required": [ "signedUrls" ] }, "SignedUploadUrlsRequest": { "type": "object", "properties": { "filenames": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 1024 } } }, "required": [ "filenames" ] }, "Order": { "type": "object", "properties": { "orderNumber": { "type": "string", "minLength": 1 }, "source": { "oneOf": [ { "type": "null" }, { "const": "etsy" }, { "const": "shopify" }, { "const": "manual" }, { "const": "ebay" }, { "const": "tiktok-shop" } ] }, "status": { "oneOf": [ { "const": "open" }, { "const": "closed" } ] }, "cancelledAt": { "oneOf": [ { "type": "null" }, { "type": "string", "format": "date-time" }, { "type": "string" } ] }, "customerId": { "oneOf": [ { "type": "null" }, { "type": "string", "pattern": "^[a-z0-9]{24}$" } ] }, "integrationId": { "oneOf": [ { "type": "null" }, { "type": "string", "pattern": "^[a-z0-9]{24}$" } ] }, "priceBucket": { "oneOf": [ { "type": "null" }, { "type": "number" } ] }, "price": { "oneOf": [ { "type": "null" }, { "type": "number" } ] }, "currency": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "externalId": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "externalUrl": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "sourceRef": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "note": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "deadline": { "oneOf": [ { "type": "null" }, { "type": "string", "format": "date-time" }, { "type": "string" } ] }, "processedAt": { "oneOf": [ { "type": "null" }, { "type": "string", "format": "date-time" }, { "type": "string" } ] }, "syncDisabled": { "type": "boolean" }, "id": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "storeId": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "orderNumber", "status", "syncDisabled", "id", "storeId", "createdAt", "updatedAt" ], "description": "Order entity representing a retail order" }, "orderNumberstringundefinedsourcestringundefinedstatusstringundefinedcancelledAtstringundefinedcustomerIdstringundefinedintegrationIdstringundefined...13more...updatedAtstringundefinedQuerySettings...": { "type": "object", "properties": { "orderNumber": { "type": "string" }, "source": { "type": "string" }, "status": { "type": "string" }, "cancelledAt": { "type": "string" }, "customerId": { "type": "string" }, "integrationId": { "type": "string" }, "priceBucket": { "type": "string" }, "price": { "type": "string" }, "currency": { "type": "string" }, "externalId": { "type": "string" }, "externalUrl": { "type": "string" }, "sourceRef": { "type": "string" }, "note": { "type": "string" }, "deadline": { "type": "string" }, "processedAt": { "type": "string" }, "syncDisabled": { "type": "string" }, "id": { "type": "string" }, "storeId": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "sort": { "type": "string", "title": "Sort", "description": "Sort specification in format \"field:asc,field2:desc\"" }, "limit": { "type": "number", "minimum": 1, "maximum": 1000, "title": "Limit", "description": "Maximum number of results to return (default: 100, max: 1000)" }, "offset": { "type": "number", "minimum": 0, "title": "Offset", "description": "Number of results to skip for pagination" }, "fields": { "type": "string", "title": "Fields", "description": "Comma-separated list of fields to return" }, "include": { "type": "string", "title": "Include", "description": "Comma-separated list of relations to include (max 4, max 2 levels deep).\nExample: \"linkedParts,linkedParts.part,folder\"" }, "meta": { "type": "boolean", "title": "Meta", "description": "If true, returns response with metadata (total, count, hasMore, etc.)" }, "hints": { "type": "boolean", "title": "Hints", "description": "If true, returns AI-friendly hints about available actions. Implies meta=true." } } }, "OrderItem": { "type": "object", "properties": { "orderId": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "skuId": { "oneOf": [ { "type": "null" }, { "type": "string", "pattern": "^[a-z0-9]{24}$" } ] }, "source": { "oneOf": [ { "type": "null" }, { "const": "etsy" }, { "const": "shopify" }, { "const": "manual" }, { "const": "ebay" }, { "const": "tiktok-shop" } ] }, "quantity": { "type": "number", "minimum": 1 }, "inputs": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/Recordstringany" } ] }, "status": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "externalId": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "externalOrderId": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "externalProductId": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "externalSku": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "originalSku": { "oneOf": [ { "type": "null" }, { "type": "string" } ], "description": "Original SKU identifier sent when creating the order item (sku or externalSku), null if skuId was provided directly" }, "processedAt": { "oneOf": [ { "type": "null" }, { "type": "string", "format": "date-time" } ] }, "ignored": { "oneOf": [ { "type": "null" }, { "type": "boolean" } ] }, "processedStatus": { "oneOf": [ { "type": "null" }, { "const": "unprocessed" }, { "const": "processed" } ] }, "skuConfig": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/OrderItemSkuConfig" } ] }, "resolutionNote": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/ResolutionNote" } ], "description": "Describes why SKU or variant resolution failed, null when resolved successfully" }, "id": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "storeId": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "orderId", "skuId", "quantity", "id", "storeId", "createdAt", "updatedAt" ], "description": "OrderItem entity representing an item in a retail order" }, "OrderItemSkuConfig": { "type": "object", "properties": { "linkedPartConfigs": { "$ref": "#/components/schemas/RecordCuid2LinkedPartConfigV2" }, "selectedOptions": { "$ref": "#/components/schemas/Recordstringstringnull" } }, "description": "SKU configuration stored with order items\nContains only the configuration overrides, not the SKU reference" }, "ResolutionNote": { "type": "object", "properties": { "type": { "oneOf": [ { "const": "variant_enrichment_failed" }, { "const": "sku_not_found" }, { "const": "ambiguous_match" } ] }, "message": { "type": "string" }, "retriable": { "type": "boolean", "description": "Whether this failure can be retried (e.g., API errors are retriable, missing SKUs are not)" }, "occurredAt": { "type": "number", "description": "Timestamp of when this failure occurred" } }, "required": [ "type", "message", "retriable", "occurredAt" ], "description": "Structured note describing why SKU or variant resolution failed.\nStored as a dedicated column on order_items for easy querying." }, "Customer": { "type": "object", "properties": { "name": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "email": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "phone": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "countryCode": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "provinceCode": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "zipCode": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "externalId": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "source": { "oneOf": [ { "type": "null" }, { "const": "etsy" }, { "const": "shopify" }, { "const": "manual" }, { "const": "ebay" }, { "const": "tiktok-shop" } ] }, "id": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "storeId": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "id", "storeId", "createdAt", "updatedAt" ], "description": "Customer entity representing a retail customer" }, "OrderDetailsResponse": { "type": "object", "properties": { "order": { "$ref": "#/components/schemas/Order" }, "customer": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/Customer" } ] }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/OrderItem" } } }, "required": [ "order", "customer", "items" ] }, "CreateOrderDto": { "type": "object", "properties": { "order": { "$ref": "#/components/schemas/OrderInsert" }, "customer": { "$ref": "#/components/schemas/CustomerInsert" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/CreateOrderItemInput" } } }, "required": [ "order" ] }, "OrderInsert": { "type": "object", "properties": { "externalId": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "source": { "oneOf": [ { "type": "null" }, { "const": "etsy" }, { "const": "shopify" }, { "const": "manual" }, { "const": "ebay" }, { "const": "tiktok-shop" } ] }, "integrationId": { "oneOf": [ { "type": "null" }, { "type": "string", "pattern": "^[a-z0-9]{24}$" } ] }, "orderNumber": { "type": "string", "minLength": 1 }, "customerId": { "oneOf": [ { "type": "null" }, { "type": "string", "pattern": "^[a-z0-9]{24}$" } ] }, "priceBucket": { "oneOf": [ { "type": "null" }, { "type": "number" } ] }, "price": { "oneOf": [ { "type": "null" }, { "type": "number" } ] }, "currency": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "externalUrl": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "note": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "deadline": { "oneOf": [ { "type": "null" }, { "type": "string", "format": "date-time" }, { "type": "string" } ] }, "processedAt": { "oneOf": [ { "type": "null" }, { "type": "string", "format": "date-time" }, { "type": "string" } ] }, "sourceRef": { "oneOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": [ "orderNumber" ] }, "CustomerInsert": { "type": "object", "properties": { "name": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "externalId": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "source": { "oneOf": [ { "type": "null" }, { "const": "etsy" }, { "const": "shopify" }, { "const": "manual" }, { "const": "ebay" }, { "const": "tiktok-shop" } ] }, "email": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "phone": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "countryCode": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "provinceCode": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "zipCode": { "oneOf": [ { "type": "null" }, { "type": "string" } ] } } }, "CreateOrderItemInput": { "type": "object", "properties": { "skuId": { "oneOf": [ { "type": "null" }, { "type": "string" } ], "title": "Internal SKU ID (Cuid2). Takes precedence over `sku` if both provided", "description": "Internal SKU ID (Cuid2). Takes precedence over `sku` if both provided." }, "sku": { "oneOf": [ { "type": "null" }, { "type": "string" } ], "title": "SKU code (e.g., \"SSP00214\"). Will be resolved to skuId if skuId not provided", "description": "SKU code (e.g., \"SSP00214\"). Will be resolved to skuId if skuId not provided." }, "externalId": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "source": { "oneOf": [ { "type": "null" }, { "const": "etsy" }, { "const": "shopify" }, { "const": "manual" }, { "const": "ebay" }, { "const": "tiktok-shop" } ] }, "status": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "processedAt": { "oneOf": [ { "type": "null" }, { "type": "string", "format": "date-time" } ] }, "quantity": { "type": "number", "minimum": 1 }, "inputs": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/Recordstringany" } ] }, "externalOrderId": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "externalProductId": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "externalSku": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "originalSku": { "oneOf": [ { "type": "null" }, { "type": "string" } ], "description": "Original SKU identifier sent when creating the order item (sku or externalSku), null if skuId was provided directly" }, "processedStatus": { "oneOf": [ { "type": "null" }, { "const": "unprocessed" }, { "const": "processed" } ] }, "ignored": { "oneOf": [ { "type": "null" }, { "type": "boolean" } ] }, "skuConfig": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/OrderItemSkuConfig" } ] }, "resolutionNote": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/ResolutionNote" } ], "description": "Describes why SKU or variant resolution failed, null when resolved successfully" } }, "required": [ "quantity" ], "description": "Order item input for creating orders via API.\nAccepts either `skuId` (internal ID) or `sku` (SKU code) to identify the SKU.\nIf `sku` is provided and `skuId` is not, the system will look up the SKU by code." }, "IgnoredSku": { "type": "object", "properties": { "skus": { "type": "array", "items": { "type": "string" } }, "id": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "storeId": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "skus", "id", "storeId", "createdAt", "updatedAt" ] }, "CheckIgnoredSkusResponse": { "type": "object", "properties": {}, "additionalProperties": { "type": "boolean" } }, "CheckIgnoredSkusRequest": { "type": "object", "properties": { "skus": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 1024 } } }, "required": [ "skus" ] }, "EditIgnoredSkusRequest": { "type": "object", "properties": { "add": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 1024 } }, "remove": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 1024 } } } }, "ReconcileJobsResponse": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "string" } } }, "required": [ "errors" ] }, "ReconcileJobsRequest": { "type": "object", "properties": { "skuIds": { "type": "array", "items": { "type": "string", "pattern": "^[a-z0-9]{24}$" } }, "orderIds": { "type": "array", "items": { "type": "string", "pattern": "^[a-z0-9]{24}$" } }, "printerTags": { "$ref": "#/components/schemas/PartialRecordstringstring" }, "priority": { "oneOf": [ { "const": 100 }, { "const": 1000 } ] }, "position": { "oneOf": [ { "const": "front" }, { "const": "back" } ] } }, "required": [ "skuIds" ] }, "PartialRecordstringstring": { "type": "object", "properties": {}, "description": "Make all properties in T optional", "additionalProperties": { "type": "string" } }, "CreateCustomerDto": { "type": "object", "properties": { "name": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "email": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "phone": { "oneOf": [ { "type": "null" }, { "type": "string" } ] } } }, "OmitOrderItemInsertorderId": { "type": "object", "properties": { "externalId": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "source": { "oneOf": [ { "type": "null" }, { "const": "etsy" }, { "const": "shopify" }, { "const": "manual" }, { "const": "ebay" }, { "const": "tiktok-shop" } ] }, "skuId": { "oneOf": [ { "type": "null" }, { "type": "string", "pattern": "^[a-z0-9]{24}$" } ] }, "status": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "processedAt": { "oneOf": [ { "type": "null" }, { "type": "string", "format": "date-time" } ] }, "quantity": { "type": "number", "minimum": 1 }, "inputs": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/Recordstringany" } ] }, "externalOrderId": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "externalProductId": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "externalSku": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "originalSku": { "oneOf": [ { "type": "null" }, { "type": "string" } ], "description": "Original SKU identifier sent when creating the order item (sku or externalSku), null if skuId was provided directly" }, "processedStatus": { "oneOf": [ { "type": "null" }, { "const": "unprocessed" }, { "const": "processed" } ] }, "ignored": { "oneOf": [ { "type": "null" }, { "type": "boolean" } ] }, "skuConfig": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/OrderItemSkuConfig" } ] }, "resolutionNote": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/ResolutionNote" } ], "description": "Describes why SKU or variant resolution failed, null when resolved successfully" } }, "required": [ "skuId", "quantity" ], "description": "Construct a type with the properties of T except for those in type K." }, "PartialOrderItemUpdate": { "type": "object", "properties": { "externalId": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "source": { "oneOf": [ { "type": "null" }, { "const": "etsy" }, { "const": "shopify" }, { "const": "manual" }, { "const": "ebay" }, { "const": "tiktok-shop" } ] }, "status": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "processedAt": { "oneOf": [ { "type": "null" }, { "type": "string", "format": "date-time" } ] }, "quantity": { "type": "number", "minimum": 1 }, "inputs": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/Recordstringany" } ] }, "externalOrderId": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "externalProductId": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "externalSku": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "originalSku": { "oneOf": [ { "type": "null" }, { "type": "string" } ], "description": "Original SKU identifier sent when creating the order item (sku or externalSku), null if skuId was provided directly" }, "processedStatus": { "oneOf": [ { "type": "null" }, { "const": "unprocessed" }, { "const": "processed" } ] }, "ignored": { "oneOf": [ { "type": "null" }, { "type": "boolean" } ] }, "skuConfig": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/OrderItemSkuConfig" } ] }, "resolutionNote": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/ResolutionNote" } ], "description": "Describes why SKU or variant resolution failed, null when resolved successfully" } }, "description": "Make all properties in T optional" }, "PartialOrder": { "type": "object", "properties": { "orderNumber": { "type": "string", "minLength": 1 }, "source": { "oneOf": [ { "type": "null" }, { "const": "etsy" }, { "const": "shopify" }, { "const": "manual" }, { "const": "ebay" }, { "const": "tiktok-shop" } ] }, "status": { "oneOf": [ { "const": "open" }, { "const": "closed" } ] }, "cancelledAt": { "oneOf": [ { "type": "null" }, { "type": "string", "format": "date-time" }, { "type": "string" } ] }, "customerId": { "oneOf": [ { "type": "null" }, { "type": "string", "pattern": "^[a-z0-9]{24}$" } ] }, "integrationId": { "oneOf": [ { "type": "null" }, { "type": "string", "pattern": "^[a-z0-9]{24}$" } ] }, "priceBucket": { "oneOf": [ { "type": "null" }, { "type": "number" } ] }, "price": { "oneOf": [ { "type": "null" }, { "type": "number" } ] }, "currency": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "externalId": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "externalUrl": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "sourceRef": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "note": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "deadline": { "oneOf": [ { "type": "null" }, { "type": "string", "format": "date-time" }, { "type": "string" } ] }, "processedAt": { "oneOf": [ { "type": "null" }, { "type": "string", "format": "date-time" }, { "type": "string" } ] }, "syncDisabled": { "type": "boolean" }, "id": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "storeId": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "description": "Make all properties in T optional" }, "SearchQueryDtoOrder": { "type": "object", "properties": { "filter": { "oneOf": [ { "$ref": "#/components/schemas/LogicalConditionOrder" }, { "$ref": "#/components/schemas/FieldConditionOrder" } ], "title": "Filter", "description": "Complex filter conditions using logical and field operators.\nAvailable field operators: eq, ne, gt, gte, lt, lte, contains, startsWith, endsWith, in, notIn, isNull, between.\nUsage example: {\"filter\": {\"and\": [{\"name\": {\"contains\": \"benchy\"}}, {\"or\": [{\"type\": {\"eq\": \"3mf\"}}, {\"type\": {\"eq\": \"gcode3mf\"}}]}}}" }, "sort": { "type": "string", "title": "Sort", "description": "Sort specification in format \"field:asc,field2:desc\"" }, "limit": { "type": "number", "minimum": 1, "maximum": 1000, "title": "Limit", "description": "Maximum number of results to return (default: 100, max: 1000)" }, "offset": { "type": "number", "minimum": 0, "title": "Offset", "description": "Number of results to skip for pagination" }, "fields": { "type": "string", "title": "Fields", "description": "Comma-separated list of fields to return" }, "include": { "type": "string", "title": "Include", "description": "Comma-separated list of relations to include (max 4, max 2 levels deep).\nExample: \"linkedParts,linkedParts.part,folder\"" }, "meta": { "type": "boolean", "title": "Meta", "description": "If true, returns response with metadata (total, count, hasMore, etc.)" }, "hints": { "type": "boolean", "title": "Hints", "description": "If true, returns AI-friendly hints about available actions. Implies meta=true." } }, "title": "Search Query", "description": "Complete search request with filter conditions and query settings" }, "LogicalConditionOrder": { "type": "object", "properties": { "and": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/LogicalConditionOrder" }, { "$ref": "#/components/schemas/FieldConditionOrder" } ] }, "title": "AND Conditions", "description": "All conditions must be true" }, "or": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/LogicalConditionOrder" }, { "$ref": "#/components/schemas/FieldConditionOrder" } ] }, "title": "OR Conditions", "description": "At least one condition must be true" } }, "title": "Logical Condition", "description": "Logical operators for combining multiple filter conditions" }, "FieldConditionOrder": { "type": "object", "properties": { "orderNumber": { "$ref": "#/components/schemas/FieldOperators" }, "source": { "$ref": "#/components/schemas/FieldOperators" }, "status": { "$ref": "#/components/schemas/FieldOperators" }, "cancelledAt": { "$ref": "#/components/schemas/FieldOperators" }, "customerId": { "$ref": "#/components/schemas/FieldOperators" }, "integrationId": { "$ref": "#/components/schemas/FieldOperators" }, "priceBucket": { "$ref": "#/components/schemas/FieldOperators" }, "price": { "$ref": "#/components/schemas/FieldOperators" }, "currency": { "$ref": "#/components/schemas/FieldOperators" }, "externalId": { "$ref": "#/components/schemas/FieldOperators" }, "externalUrl": { "$ref": "#/components/schemas/FieldOperators" }, "sourceRef": { "$ref": "#/components/schemas/FieldOperators" }, "note": { "$ref": "#/components/schemas/FieldOperators" }, "deadline": { "$ref": "#/components/schemas/FieldOperators" }, "processedAt": { "$ref": "#/components/schemas/FieldOperators" }, "syncDisabled": { "$ref": "#/components/schemas/FieldOperators" }, "id": { "$ref": "#/components/schemas/FieldOperators" }, "storeId": { "$ref": "#/components/schemas/FieldOperators" }, "createdAt": { "$ref": "#/components/schemas/FieldOperators" }, "updatedAt": { "$ref": "#/components/schemas/FieldOperators" } }, "title": "Field Condition", "description": "Field-based filter conditions where keys are field names and values are field operators" }, "orderIdstringundefinedskuIdstringundefinedsourcestringundefinedquantitystringundefinedinputsstringundefinedstatusstringundefinedexternalIdstringundefined...12more...updatedAtstringundefinedQuerySettings...": { "type": "object", "properties": { "orderId": { "type": "string" }, "skuId": { "type": "string" }, "source": { "type": "string" }, "quantity": { "type": "string" }, "inputs": { "type": "string" }, "status": { "type": "string" }, "externalId": { "type": "string" }, "externalOrderId": { "type": "string" }, "externalProductId": { "type": "string" }, "externalSku": { "type": "string" }, "originalSku": { "type": "string", "description": "Original SKU identifier sent when creating the order item (sku or externalSku), null if skuId was provided directly" }, "processedAt": { "type": "string" }, "ignored": { "type": "string" }, "processedStatus": { "type": "string" }, "skuConfig": { "type": "string" }, "resolutionNote": { "type": "string", "description": "Describes why SKU or variant resolution failed, null when resolved successfully" }, "id": { "type": "string" }, "storeId": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "sort": { "type": "string", "title": "Sort", "description": "Sort specification in format \"field:asc,field2:desc\"" }, "limit": { "type": "number", "minimum": 1, "maximum": 1000, "title": "Limit", "description": "Maximum number of results to return (default: 100, max: 1000)" }, "offset": { "type": "number", "minimum": 0, "title": "Offset", "description": "Number of results to skip for pagination" }, "fields": { "type": "string", "title": "Fields", "description": "Comma-separated list of fields to return" }, "include": { "type": "string", "title": "Include", "description": "Comma-separated list of relations to include (max 4, max 2 levels deep).\nExample: \"linkedParts,linkedParts.part,folder\"" }, "meta": { "type": "boolean", "title": "Meta", "description": "If true, returns response with metadata (total, count, hasMore, etc.)" }, "hints": { "type": "boolean", "title": "Hints", "description": "If true, returns AI-friendly hints about available actions. Implies meta=true." } } }, "SearchQueryDtoOrderItem": { "type": "object", "properties": { "filter": { "oneOf": [ { "$ref": "#/components/schemas/LogicalConditionOrderItem" }, { "$ref": "#/components/schemas/FieldConditionOrderItem" } ], "title": "Filter", "description": "Complex filter conditions using logical and field operators.\nAvailable field operators: eq, ne, gt, gte, lt, lte, contains, startsWith, endsWith, in, notIn, isNull, between.\nUsage example: {\"filter\": {\"and\": [{\"name\": {\"contains\": \"benchy\"}}, {\"or\": [{\"type\": {\"eq\": \"3mf\"}}, {\"type\": {\"eq\": \"gcode3mf\"}}]}}}" }, "sort": { "type": "string", "title": "Sort", "description": "Sort specification in format \"field:asc,field2:desc\"" }, "limit": { "type": "number", "minimum": 1, "maximum": 1000, "title": "Limit", "description": "Maximum number of results to return (default: 100, max: 1000)" }, "offset": { "type": "number", "minimum": 0, "title": "Offset", "description": "Number of results to skip for pagination" }, "fields": { "type": "string", "title": "Fields", "description": "Comma-separated list of fields to return" }, "include": { "type": "string", "title": "Include", "description": "Comma-separated list of relations to include (max 4, max 2 levels deep).\nExample: \"linkedParts,linkedParts.part,folder\"" }, "meta": { "type": "boolean", "title": "Meta", "description": "If true, returns response with metadata (total, count, hasMore, etc.)" }, "hints": { "type": "boolean", "title": "Hints", "description": "If true, returns AI-friendly hints about available actions. Implies meta=true." } }, "title": "Search Query", "description": "Complete search request with filter conditions and query settings" }, "LogicalConditionOrderItem": { "type": "object", "properties": { "and": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/LogicalConditionOrderItem" }, { "$ref": "#/components/schemas/FieldConditionOrderItem" } ] }, "title": "AND Conditions", "description": "All conditions must be true" }, "or": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/LogicalConditionOrderItem" }, { "$ref": "#/components/schemas/FieldConditionOrderItem" } ] }, "title": "OR Conditions", "description": "At least one condition must be true" } }, "title": "Logical Condition", "description": "Logical operators for combining multiple filter conditions" }, "FieldConditionOrderItem": { "type": "object", "properties": { "orderId": { "$ref": "#/components/schemas/FieldOperators" }, "skuId": { "$ref": "#/components/schemas/FieldOperators" }, "source": { "$ref": "#/components/schemas/FieldOperators" }, "quantity": { "$ref": "#/components/schemas/FieldOperators" }, "inputs": { "$ref": "#/components/schemas/FieldOperators" }, "status": { "$ref": "#/components/schemas/FieldOperators" }, "externalId": { "$ref": "#/components/schemas/FieldOperators" }, "externalOrderId": { "$ref": "#/components/schemas/FieldOperators" }, "externalProductId": { "$ref": "#/components/schemas/FieldOperators" }, "externalSku": { "$ref": "#/components/schemas/FieldOperators" }, "originalSku": { "$ref": "#/components/schemas/FieldOperators", "description": "Original SKU identifier sent when creating the order item (sku or externalSku), null if skuId was provided directly" }, "processedAt": { "$ref": "#/components/schemas/FieldOperators" }, "ignored": { "$ref": "#/components/schemas/FieldOperators" }, "processedStatus": { "$ref": "#/components/schemas/FieldOperators" }, "skuConfig": { "$ref": "#/components/schemas/FieldOperators" }, "resolutionNote": { "$ref": "#/components/schemas/FieldOperators", "description": "Describes why SKU or variant resolution failed, null when resolved successfully" }, "id": { "$ref": "#/components/schemas/FieldOperators" }, "storeId": { "$ref": "#/components/schemas/FieldOperators" }, "createdAt": { "$ref": "#/components/schemas/FieldOperators" }, "updatedAt": { "$ref": "#/components/schemas/FieldOperators" } }, "title": "Field Condition", "description": "Field-based filter conditions where keys are field names and values are field operators" }, "namestringundefinedemailstringundefinedphonestringundefinedcountryCodestringundefinedprovinceCodestringundefinedzipCodestringundefined...5more...updatedAtstringundefinedQuerySettings...": { "type": "object", "properties": { "name": { "type": "string" }, "email": { "type": "string" }, "phone": { "type": "string" }, "countryCode": { "type": "string" }, "provinceCode": { "type": "string" }, "zipCode": { "type": "string" }, "externalId": { "type": "string" }, "source": { "type": "string" }, "id": { "type": "string" }, "storeId": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "sort": { "type": "string", "title": "Sort", "description": "Sort specification in format \"field:asc,field2:desc\"" }, "limit": { "type": "number", "minimum": 1, "maximum": 1000, "title": "Limit", "description": "Maximum number of results to return (default: 100, max: 1000)" }, "offset": { "type": "number", "minimum": 0, "title": "Offset", "description": "Number of results to skip for pagination" }, "fields": { "type": "string", "title": "Fields", "description": "Comma-separated list of fields to return" }, "include": { "type": "string", "title": "Include", "description": "Comma-separated list of relations to include (max 4, max 2 levels deep).\nExample: \"linkedParts,linkedParts.part,folder\"" }, "meta": { "type": "boolean", "title": "Meta", "description": "If true, returns response with metadata (total, count, hasMore, etc.)" }, "hints": { "type": "boolean", "title": "Hints", "description": "If true, returns AI-friendly hints about available actions. Implies meta=true." } } }, "SearchQueryDtoCustomer": { "type": "object", "properties": { "filter": { "oneOf": [ { "$ref": "#/components/schemas/LogicalConditionCustomer" }, { "$ref": "#/components/schemas/FieldConditionCustomer" } ], "title": "Filter", "description": "Complex filter conditions using logical and field operators.\nAvailable field operators: eq, ne, gt, gte, lt, lte, contains, startsWith, endsWith, in, notIn, isNull, between.\nUsage example: {\"filter\": {\"and\": [{\"name\": {\"contains\": \"benchy\"}}, {\"or\": [{\"type\": {\"eq\": \"3mf\"}}, {\"type\": {\"eq\": \"gcode3mf\"}}]}}}" }, "sort": { "type": "string", "title": "Sort", "description": "Sort specification in format \"field:asc,field2:desc\"" }, "limit": { "type": "number", "minimum": 1, "maximum": 1000, "title": "Limit", "description": "Maximum number of results to return (default: 100, max: 1000)" }, "offset": { "type": "number", "minimum": 0, "title": "Offset", "description": "Number of results to skip for pagination" }, "fields": { "type": "string", "title": "Fields", "description": "Comma-separated list of fields to return" }, "include": { "type": "string", "title": "Include", "description": "Comma-separated list of relations to include (max 4, max 2 levels deep).\nExample: \"linkedParts,linkedParts.part,folder\"" }, "meta": { "type": "boolean", "title": "Meta", "description": "If true, returns response with metadata (total, count, hasMore, etc.)" }, "hints": { "type": "boolean", "title": "Hints", "description": "If true, returns AI-friendly hints about available actions. Implies meta=true." } }, "title": "Search Query", "description": "Complete search request with filter conditions and query settings" }, "LogicalConditionCustomer": { "type": "object", "properties": { "and": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/LogicalConditionCustomer" }, { "$ref": "#/components/schemas/FieldConditionCustomer" } ] }, "title": "AND Conditions", "description": "All conditions must be true" }, "or": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/LogicalConditionCustomer" }, { "$ref": "#/components/schemas/FieldConditionCustomer" } ] }, "title": "OR Conditions", "description": "At least one condition must be true" } }, "title": "Logical Condition", "description": "Logical operators for combining multiple filter conditions" }, "FieldConditionCustomer": { "type": "object", "properties": { "name": { "$ref": "#/components/schemas/FieldOperators" }, "email": { "$ref": "#/components/schemas/FieldOperators" }, "phone": { "$ref": "#/components/schemas/FieldOperators" }, "countryCode": { "$ref": "#/components/schemas/FieldOperators" }, "provinceCode": { "$ref": "#/components/schemas/FieldOperators" }, "zipCode": { "$ref": "#/components/schemas/FieldOperators" }, "externalId": { "$ref": "#/components/schemas/FieldOperators" }, "source": { "$ref": "#/components/schemas/FieldOperators" }, "id": { "$ref": "#/components/schemas/FieldOperators" }, "storeId": { "$ref": "#/components/schemas/FieldOperators" }, "createdAt": { "$ref": "#/components/schemas/FieldOperators" }, "updatedAt": { "$ref": "#/components/schemas/FieldOperators" } }, "title": "Field Condition", "description": "Field-based filter conditions where keys are field names and values are field operators" }, "skusstringundefinedidstringundefinedstoreIdstringundefinedcreatedAtstringundefinedupdatedAtstringundefinedQuerySettings...": { "type": "object", "properties": { "skus": { "type": "string" }, "id": { "type": "string" }, "storeId": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "sort": { "type": "string", "title": "Sort", "description": "Sort specification in format \"field:asc,field2:desc\"" }, "limit": { "type": "number", "minimum": 1, "maximum": 1000, "title": "Limit", "description": "Maximum number of results to return (default: 100, max: 1000)" }, "offset": { "type": "number", "minimum": 0, "title": "Offset", "description": "Number of results to skip for pagination" }, "fields": { "type": "string", "title": "Fields", "description": "Comma-separated list of fields to return" }, "include": { "type": "string", "title": "Include", "description": "Comma-separated list of relations to include (max 4, max 2 levels deep).\nExample: \"linkedParts,linkedParts.part,folder\"" }, "meta": { "type": "boolean", "title": "Meta", "description": "If true, returns response with metadata (total, count, hasMore, etc.)" }, "hints": { "type": "boolean", "title": "Hints", "description": "If true, returns AI-friendly hints about available actions. Implies meta=true." } } }, "SearchQueryDtoIgnoredSku": { "type": "object", "properties": { "filter": { "oneOf": [ { "$ref": "#/components/schemas/LogicalConditionIgnoredSku" }, { "$ref": "#/components/schemas/FieldConditionIgnoredSku" } ], "title": "Filter", "description": "Complex filter conditions using logical and field operators.\nAvailable field operators: eq, ne, gt, gte, lt, lte, contains, startsWith, endsWith, in, notIn, isNull, between.\nUsage example: {\"filter\": {\"and\": [{\"name\": {\"contains\": \"benchy\"}}, {\"or\": [{\"type\": {\"eq\": \"3mf\"}}, {\"type\": {\"eq\": \"gcode3mf\"}}]}}}" }, "sort": { "type": "string", "title": "Sort", "description": "Sort specification in format \"field:asc,field2:desc\"" }, "limit": { "type": "number", "minimum": 1, "maximum": 1000, "title": "Limit", "description": "Maximum number of results to return (default: 100, max: 1000)" }, "offset": { "type": "number", "minimum": 0, "title": "Offset", "description": "Number of results to skip for pagination" }, "fields": { "type": "string", "title": "Fields", "description": "Comma-separated list of fields to return" }, "include": { "type": "string", "title": "Include", "description": "Comma-separated list of relations to include (max 4, max 2 levels deep).\nExample: \"linkedParts,linkedParts.part,folder\"" }, "meta": { "type": "boolean", "title": "Meta", "description": "If true, returns response with metadata (total, count, hasMore, etc.)" }, "hints": { "type": "boolean", "title": "Hints", "description": "If true, returns AI-friendly hints about available actions. Implies meta=true." } }, "title": "Search Query", "description": "Complete search request with filter conditions and query settings" }, "LogicalConditionIgnoredSku": { "type": "object", "properties": { "and": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/LogicalConditionIgnoredSku" }, { "$ref": "#/components/schemas/FieldConditionIgnoredSku" } ] }, "title": "AND Conditions", "description": "All conditions must be true" }, "or": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/LogicalConditionIgnoredSku" }, { "$ref": "#/components/schemas/FieldConditionIgnoredSku" } ] }, "title": "OR Conditions", "description": "At least one condition must be true" } }, "title": "Logical Condition", "description": "Logical operators for combining multiple filter conditions" }, "FieldConditionIgnoredSku": { "type": "object", "properties": { "skus": { "$ref": "#/components/schemas/FieldOperators" }, "id": { "$ref": "#/components/schemas/FieldOperators" }, "storeId": { "$ref": "#/components/schemas/FieldOperators" }, "createdAt": { "$ref": "#/components/schemas/FieldOperators" }, "updatedAt": { "$ref": "#/components/schemas/FieldOperators" } }, "title": "Field Condition", "description": "Field-based filter conditions where keys are field names and values are field operators" }, "UsageStats.o1": { "type": "object", "properties": { "tier": { "oneOf": [ { "type": "null" }, { "const": "etsy-starter" }, { "const": "etsy-pro" } ] }, "orders": { "type": "object", "properties": { "current": { "type": "number" }, "limit": { "oneOf": [ { "type": "null" }, { "type": "number" } ] }, "remaining": { "oneOf": [ { "type": "null" }, { "type": "number" } ] } }, "required": [ "current", "limit", "remaining" ] }, "listings": { "type": "object", "properties": { "current": { "type": "number" }, "limit": { "oneOf": [ { "type": "null" }, { "type": "number" } ] }, "remaining": { "oneOf": [ { "type": "null" }, { "type": "number" } ] } }, "required": [ "current", "limit", "remaining" ] }, "cycleStartDate": { "type": "string", "format": "date-time" }, "cycleEndDate": { "type": "string", "format": "date-time" } }, "required": [ "tier", "orders", "listings", "cycleStartDate", "cycleEndDate" ], "description": "Usage statistics for an Etsy integration" }, "TikTokShopSyncOrdersResult": { "type": "object", "properties": { "orders": { "type": "array", "items": { "$ref": "#/components/schemas/Order" } }, "totalSynced": { "type": "number" }, "totalAvailable": { "type": "number" }, "skipped": { "type": "number" } }, "required": [ "orders", "totalSynced", "totalAvailable", "skipped" ], "description": "Result of a sync-orders run (named for the same SDK reason as the request)." }, "TikTokShopSyncOrdersRequest": { "type": "object", "properties": { "limit": { "type": "number", "title": "Cap on orders imported in this run", "description": "Cap on orders imported in this run." }, "daysBack": { "type": "number", "title": "Only sync orders created within this many days", "description": "Only sync orders created within this many days." }, "statusGroups": { "type": "array", "items": { "oneOf": [ { "const": "completed" }, { "const": "awaiting" }, { "const": "in_transit" } ] }, "description": "Which fulfillment stages to include. Maps to TikTok order_status:\n - 'awaiting' → AWAITING_SHIPMENT + AWAITING_COLLECTION (needs action)\n - 'in_transit' → IN_TRANSIT (shipped)\n - 'completed' → DELIVERED + COMPLETED" } }, "description": "Request body for POST /v1/integrations/tiktok-shop/:integrationId/sync-orders.\n\nThis is a NAMED interface on purpose: an inline `@TypedBody()` object type\nmakes Nestia emit an anonymous `__type` in the generated SDK, which then\ncollides with the anonymous `__type` it emits for the response — producing a\nfile that imports `__type` twice and fails to compile. Naming both ends\ngives the SDK stable, non-colliding type identifiers." }, "PasskeySummary": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "credentialDeviceType": { "type": "string" }, "credentialBackedUp": { "type": "boolean" }, "transports": { "oneOf": [ { "type": "null" }, { "type": "array", "items": { "type": "string" } } ] }, "createdAt": { "type": "string" }, "lastUsedAt": { "oneOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": [ "id", "name", "credentialDeviceType", "credentialBackedUp", "transports", "createdAt", "lastUsedAt" ] }, "UpdatePasskeyRequest": { "type": "object", "properties": { "name": { "type": "string" } }, "required": [ "name" ] }, "PrinterHistoryLastResponse": { "type": "object", "properties": { "printerId": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "last": { "type": "array", "items": { "$ref": "#/components/schemas/PrinterHistoryLastEntry" } } }, "required": [ "printerId", "last" ] }, "PrinterHistoryLastEntry": { "type": "object", "properties": { "job": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/PrintJob" } ] }, "part": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/Part" } ] }, "sku": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/Sku" } ] }, "order": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/Order" } ] }, "orderItem": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/OrderItem" } ] } } }, "PrinterHistoryLastQuery": { "type": "object", "properties": { "refs": { "type": "string", "pattern": "^(part|sku|job|order|orderItem)(?:,(part|sku|job|order|orderItem))*$", "description": "Comma-separated subset of: part, sku, job, order, orderItem. Defaults\nto job when omitted." }, "limit": { "type": "integer", "minimum": 1, "maximum": 25, "title": "Number of recent terminal jobs to return, 1 to 25. Defaults to 1", "description": "Number of recent terminal jobs to return, 1 to 25. Defaults to 1." } } } }, "securitySchemes": { "bearer": { "type": "apiKey", "name": "Authorization", "in": "header" } } }, "tags": [ { "name": "Parts" }, { "name": "SKUs" }, { "name": "Printers" }, { "name": "Linked_Parts" }, { "name": "Profiles" }, { "name": "Print_Jobs" }, { "name": "Stores" }, { "name": "Printing" }, { "name": "Part_Builds" }, { "name": "Users" }, { "name": "Integrations" }, { "name": "SKU_Builds" }, { "name": "Folders" }, { "name": "Entitlements" }, { "name": "Permissions" }, { "name": "Settings" }, { "name": "Materials" }, { "name": "Material_Variants" }, { "name": "Material_Groups" }, { "name": "Material_Instances" }, { "name": "Printer_Slots" }, { "name": "SKU_Variants" }, { "name": "Cost_Catalog" }, { "name": "SKU_Costs" }, { "name": "Hints" }, { "name": "Audit_Logs" }, { "name": "Maintenance" }, { "name": "API_Keys" }, { "name": "Subscriptions" }, { "name": "Files" }, { "name": "Orders" }, { "name": "Order_Items" }, { "name": "Customers" }, { "name": "Shopify" }, { "name": "Etsy" }, { "name": "eBay" }, { "name": "TikTok", "description": "Shop" }, { "name": "Passkeys" } ], "x-samchon-emended": true }