{ "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": { "tags": [], "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Part" } } } } } } }, "post": { "tags": [], "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartInsertWithMaterials" } } }, "required": true }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Part" } } } } } }, "delete": { "tags": [], "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string", "pattern": "^[a-z0-9]{24}$" } } } }, "required": true }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string", "pattern": "^[a-z0-9]{24}$" } } } } } } } }, "/v1/parts/{id}": { "get": { "tags": [], "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Part" } } } } } }, "patch": { "tags": [], "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartUpdateWithMaterials" } } }, "required": true }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Part" } } } } } }, "delete": { "tags": [], "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } } } } }, "/v1/parts/create-skus": { "post": { "tags": [], "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "partId": { "type": "string" }, "skuName": { "type": "string" } }, "required": [ "partId", "skuName" ] } } } }, "required": true }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Sku" } } } } } } } }, "/v1/printers/set-config": { "patch": { "tags": [], "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetProviderConfig" } } }, "required": true }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Printer" } } } } } } } }, "/v1/printers/confirm-ready": { "patch": { "tags": [], "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfirmReadyRequest" } } }, "required": true }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Printer" } } } } } } } }, "/v1/printers/enabled": { "patch": { "tags": [], "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnabledConfig" } } }, "required": true }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Printer" } } } } } } } }, "/v1/printers/continous-print": { "patch": { "tags": [], "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContinuousPrintConfig" } } }, "required": true }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Printer" } } } } } } } }, "/v1/printers": { "get": { "tags": [], "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Printer" } } } } } } }, "post": { "tags": [], "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrinterInsert" } } }, "required": true }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Printer" } } } } } }, "put": { "tags": [], "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PrinterInsert" } } } }, "required": true }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Printer" } } } } } } }, "patch": { "tags": [], "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateManyRequestPrinterUpdate" } } }, "required": true }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Printer" } } } } } } }, "delete": { "tags": [], "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkActionRequest" } } }, "required": true }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } } } } }, "/v1/printers/stats": { "get": { "tags": [], "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PrinterStat" } } } } } } } }, "/v1/printers/stats/{ids}": { "get": { "tags": [], "parameters": [ { "name": "ids", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}(?:,[a-z0-9]{24})*$" }, "required": true } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PrinterStat" } } } } } } } }, "/v1/printers/{id}": { "get": { "tags": [], "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Printer" } } } } } }, "patch": { "tags": [], "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartialPrinterUpdate" } } }, "required": true }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Printer" } } } } } }, "delete": { "tags": [], "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } } } } }, "/v1/printers/multi": { "patch": { "tags": [], "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PartialPrinterUpdateidstring" } } } }, "required": true }, "responses": { "200": { "description": "", "content": { "application/json": {} } } } } }, "/v1/printers/{id}/rename": { "patch": { "tags": [], "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RenamePrinterOptions" } } }, "required": true }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Printer" } } } } } } }, "/v1/linked-parts": { "get": { "tags": [], "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LinkedPart" } } } } } } }, "post": { "tags": [], "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LinkedPartInsert" } } }, "required": true }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LinkedPart" } } } } } } }, "/v1/linked-parts/{id}": { "get": { "tags": [], "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LinkedPart" } } } } } }, "patch": { "tags": [], "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LinkedPartInsert" } } }, "required": true }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LinkedPart" } } } } } }, "delete": { "tags": [], "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } } } } }, "/v1/profiles": { "get": { "tags": [], "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Profile" } } } } } } }, "delete": { "tags": [], "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string", "pattern": "^[a-z0-9]{24}$" } } } }, "required": true }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string", "pattern": "^[a-z0-9]{24}$" } } } } } } } }, "/v1/profiles/supported": { "get": { "tags": [], "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SupportedPrinter" } } } } } } } }, "/v1/profiles/printer-models": { "get": { "tags": [], "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PrinterModel" } } } } } } } }, "/v1/profiles/my-printer-models": { "get": { "tags": [], "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PrinterModel" } } } } } } } }, "/v1/profiles/{id}": { "get": { "tags": [], "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Profile" } } } } } }, "delete": { "tags": [], "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } } } } }, "/v1/profiles/compatible/{id}": { "get": { "tags": [], "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompatibleProfiles" } } } } } } }, "/v1/profiles/compatible/{machineModel}/{nozzleDiameter}": { "get": { "tags": [], "parameters": [ { "name": "machineModel", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "nozzleDiameter", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompatibleProfiles" } } } } } } }, "/v1/print-jobs": { "get": { "tags": [], "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PrintJob" } } } } } } } }, "/v1/print-jobs/stats/completed-count": { "get": { "tags": [], "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "number" } } } } } } }, "/v1/print-jobs/pause": { "patch": { "tags": [], "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrintJobOperationRequest" } } }, "required": true }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string", "pattern": "^[a-z0-9]{24}$" } } } } } } } }, "/v1/print-jobs/cancel": { "patch": { "tags": [], "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrintJobOperationRequest" } } }, "required": true }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string", "pattern": "^[a-z0-9]{24}$" } } } } } } } }, "/v1/print-jobs/resume": { "patch": { "tags": [], "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrintJobOperationRequest" } } }, "required": true }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string", "pattern": "^[a-z0-9]{24}$" } } } } } } } }, "/v1/print-jobs/retry": { "patch": { "tags": [], "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrintJobOperationRequest" } } }, "required": true }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string", "pattern": "^[a-z0-9]{24}$" } } } } } } } }, "/v1/print-jobs/clear": { "patch": { "tags": [], "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrintJobOperationRequest" } } }, "required": true }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string", "pattern": "^[a-z0-9]{24}$" } } } } } } } }, "/v1/print-jobs/move-to-queue-front": { "patch": { "tags": [], "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrintJobOperationRequest" } } }, "required": true }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string", "pattern": "^[a-z0-9]{24}$" } } } } } } } }, "/v1/print-jobs/{id}/matching-details": { "get": { "tags": [], "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" }, { "$ref": "#/components/schemas/PrintJobMatchingDetail" } ] } } } } } } }, "/v1/print-jobs/{id}/reorder": { "patch": { "tags": [], "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReorderPrintJobRequest" } } }, "required": true }, "responses": { "200": { "description": "", "content": { "application/json": {} } } } } }, "/v1/print-jobs/bulk-reorder": { "patch": { "tags": [], "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkReorderPrintJobsRequest" } } }, "required": true }, "responses": { "200": { "description": "", "content": { "application/json": {} } } } } }, "/v1/print-jobs/{id}/start": { "patch": { "tags": [], "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AcknowledgePrintJobStartRequest" } } }, "required": true }, "responses": { "200": { "description": "", "content": { "application/json": {} } } } } }, "/v1/print-jobs/{id}": { "get": { "tags": [], "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrintJob" } } } } } }, "patch": { "tags": [], "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartialPrintJobInsert" } } }, "required": true }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrintJob" } } } } } } }, "/v1/stores": { "get": { "tags": [], "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Store" } } } } } } } }, "/v1/skus": { "get": { "tags": [], "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SkuLinkedPartsWithPartRelation" } } } } } } }, "post": { "tags": [], "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SkuInsert" } } }, "required": true }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SkuLinkedPartsRelation" } } } } } } }, "/v1/skus/{id}": { "get": { "tags": [], "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SkuLinkedPartsWithPartRelation" } } } } } }, "patch": { "tags": [], "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartialSkuInsert" } } }, "required": true }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Sku" } } } } } }, "delete": { "tags": [], "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } } } } }, "/v1/skus/delete-many": { "post": { "tags": [], "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string", "pattern": "^[a-z0-9]{24}$" } } } }, "required": true }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string", "pattern": "^[a-z0-9]{24}$" } } } } } } } }, "/v1/builds": { "post": { "tags": [], "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BuildConfig" } } }, "required": true }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BuildResult" } } } } } } }, "/v1/part-builds": { "get": { "tags": [], "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PartBuildWithRelation" } } } } } } } }, "/v1/part-builds/{id}": { "get": { "tags": [], "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartBuildWithRelation" } } } } } } }, "/v1/users/register": { "post": { "tags": [], "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserInsert" } } }, "required": true }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserStoresRelation" } } } } } } }, "/v1/integrations": { "get": { "tags": [], "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Integration" } } } } } } } }, "/v1/integrations/{id}": { "get": { "tags": [], "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Integration" } } } } } } }, "/v1/sku-builds": { "get": { "tags": [], "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SkuBuildWithRelation" } } } } } } } }, "/v1/sku-builds/{id}": { "get": { "tags": [], "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SkuBuildWithRelation" } } } } } } }, "/v1/part-build-steps": { "get": { "tags": [], "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PartBuildStep" } } } } } } } }, "/v1/part-build-steps/{id}": { "get": { "tags": [], "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartBuildStep" } } } } } } }, "/v1/folders": { "get": { "tags": [], "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Folder" } } } } } } }, "post": { "tags": [], "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateFolderRequest" } } }, "required": true }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Folder" } } } } } } }, "/v1/folders/move": { "patch": { "tags": [], "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchMoveFolderRequest" } } }, "required": true }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchMoveFolderResponse" } } } } } } }, "/v1/folders/rename": { "patch": { "tags": [], "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RenameFolderRequest" } } }, "required": true }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Folder" } } } } } } }, "/v1/folders/by-type/{type}": { "get": { "tags": [], "parameters": [ { "name": "type", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Folder" } } } } } } } }, "/v1/folders/parts": { "get": { "tags": [], "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Folder" } } } } } } } }, "/v1/folders/skus": { "get": { "tags": [], "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Folder" } } } } } } } }, "/v1/folders/delete": { "delete": { "tags": [], "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteFolderRequest" } } }, "required": true }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "affected": { "type": "number" }, "message": { "type": "string" } }, "required": [ "success", "affected" ] } } } } } } }, "/v1/folders/{id}": { "get": { "tags": [], "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Folder" } } } } } } }, "/v1/permissions/mine": { "get": { "tags": [], "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetAllPermissionsForUserResponse" } } } } } } }, "/v1/web-init": { "get": { "tags": [], "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebInitData" } } } } } } }, "/v1/printer-commands/send": { "post": { "tags": [], "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SendCommandRequest" } } }, "required": true }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } } } } }, "/v1/settings/store": { "get": { "tags": [], "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetStoreSettingsResponse" } } } } } }, "patch": { "tags": [], "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateStoreSettingsRequest" } } }, "required": true }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetStoreSettingsResponse" } } } } } } }, "/v1/settings/slicers": { "get": { "tags": [], "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetAllSlicerVersionsResponse" } } } } } } }, "/v1/materials": { "get": { "tags": [], "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Material" } } } } } } }, "post": { "tags": [], "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MaterialInsert" } } }, "required": true }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Material" } } } } } }, "delete": { "tags": [], "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string", "pattern": "^[a-z0-9]{24}$" } } } }, "required": true }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } } } } }, "/v1/materials/full": { "get": { "tags": [], "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MaterialsData" } } } } } } }, "/v1/materials/variants": { "get": { "tags": [], "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MaterialVariant" } } } } } } }, "post": { "tags": [], "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MaterialVariantInsert" } } }, "required": true }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MaterialVariant" } } } } } }, "delete": { "tags": [], "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string", "pattern": "^[a-z0-9]{24}$" } } } }, "required": true }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } } } } }, "/v1/materials/variants/{id}": { "get": { "tags": [], "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MaterialVariant" } } } } } }, "patch": { "tags": [], "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartialMaterialVariant" } } }, "required": true }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MaterialVariant" } } } } } }, "delete": { "tags": [], "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } } } } }, "/v1/materials/variants/batch": { "post": { "tags": [], "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MaterialVariantInsert" } } } }, "required": true }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MaterialVariant" } } } } } } } }, "/v1/materials/groups": { "get": { "tags": [], "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MaterialGroup" } } } } } } }, "post": { "tags": [], "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MaterialGroupInsert" } } }, "required": true }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MaterialGroup" } } } } } }, "delete": { "tags": [], "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string", "pattern": "^[a-z0-9]{24}$" } } } }, "required": true }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } } } } }, "/v1/materials/groups/{id}": { "get": { "tags": [], "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MaterialGroup" } } } } } }, "patch": { "tags": [], "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartialMaterialGroup" } } }, "required": true }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MaterialGroup" } } } } } }, "delete": { "tags": [], "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } } } } }, "/v1/materials/group-members": { "get": { "tags": [], "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MaterialGroupMember" } } } } } } }, "post": { "tags": [], "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MaterialGroupMemberInsert" } } }, "required": true }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MaterialGroupMember" } } } } } }, "delete": { "tags": [], "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string", "pattern": "^[a-z0-9]{24}$" } } } }, "required": true }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string", "pattern": "^[a-z0-9]{24}$" } } } } } } } }, "/v1/materials/group-members/group/{groupId}": { "get": { "tags": [], "parameters": [ { "name": "groupId", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MaterialGroupMember" } } } } } } } }, "/v1/materials/group-members/{id}": { "get": { "tags": [], "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" }, { "$ref": "#/components/schemas/MaterialGroupMember" } ] } } } } } } }, "/v1/materials/assignments": { "get": { "tags": [], "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PartMaterialAssignment" } } } } } } }, "delete": { "tags": [], "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string", "pattern": "^[a-z0-9]{24}$" } } } }, "required": true }, "responses": { "200": { "description": "", "content": { "application/json": {} } } } } }, "/v1/materials/assignments/part/{partId}": { "get": { "tags": [], "parameters": [ { "name": "partId", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PartMaterialAssignment" } } } } } } } }, "/v1/materials/assignments/{id}": { "get": { "tags": [], "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" }, { "$ref": "#/components/schemas/PartMaterialAssignment" } ] } } } } } } }, "/v1/materials/parts/{partId}/assignments": { "post": { "tags": [], "parameters": [ { "name": "partId", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartMaterialAssignmentInsert" } } }, "required": true }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartMaterialAssignment" } } } } } }, "delete": { "tags": [], "parameters": [ { "name": "partId", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true } ], "responses": { "200": { "description": "", "content": { "application/json": {} } } } } }, "/v1/materials/instances": { "get": { "tags": [], "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MaterialInstance" } } } } } } }, "post": { "tags": [], "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MaterialInstanceInsert" } } }, "required": true }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MaterialInstance" } } } } } } }, "/v1/materials/instances/{id}": { "get": { "tags": [], "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" }, { "$ref": "#/components/schemas/MaterialInstance" } ] } } } } } }, "put": { "tags": [], "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartialMaterialInstance" } } }, "required": true }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MaterialInstance" } } } } } }, "delete": { "tags": [], "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } } } } }, "/v1/materials/printer-slots": { "get": { "tags": [], "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PrinterSlot" } } } } } } } }, "/v1/materials/profiles": { "get": { "tags": [], "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MaterialProfileAssignment" } } } } } } } }, "/v1/materials/printer-slots/assign": { "patch": { "tags": [], "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/printerIdsCuid2slotsnumbersetOnPrinterbooleanundefinedmaterialTypestringfilamentUserProfileIdCuid2nullundefinedfilamentSystemProfileIdnumber...1more...undefinedvariantIdnullundefinedmaterialIdnullundefinedinstanceIdnullundefined" }, { "$ref": "#/components/schemas/printerIdsCuid2slotsnumbersetOnPrinterbooleanundefinedinstanceIdCuid2filamentUserProfileIdCuid2nullundefinedfilamentSystemProfileIdnumber...1more...undefinedvariantIdnullundefinedmaterialIdnullundefinedmaterialTypenullundefined" }, { "$ref": "#/components/schemas/printerIdsCuid2slotsnumbersetOnPrinterbooleanundefinedvariantIdCuid2filamentUserProfileIdCuid2nullundefinedfilamentSystemProfileIdnumber...1more...undefinedinstanceIdnullundefinedmaterialIdnullundefinedmaterialTypenullundefined" }, { "$ref": "#/components/schemas/printerIdsCuid2slotsnumbersetOnPrinterbooleanundefinedmaterialIdCuid2filamentUserProfileIdCuid2nullundefinedfilamentSystemProfileIdnumber...1more...undefinedinstanceIdnullundefinedvariantIdnullundefinedmaterialTypenullundefined" } ] } } }, "required": true }, "responses": { "200": { "description": "", "content": { "application/json": {} } } } } }, "/v1/materials/printer-slots/profile": { "patch": { "tags": [], "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetSlotProfileRequest" } } }, "required": true }, "responses": { "200": { "description": "", "content": { "application/json": {} } } } } }, "/v1/materials/printer-slots/clear": { "patch": { "tags": [], "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClearPrinterSlotRequest" } } }, "required": true }, "responses": { "200": { "description": "", "content": { "application/json": {} } } } } }, "/v1/materials/printer-slots/clear-all": { "delete": { "tags": [], "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkActionRequest" } } }, "required": true }, "responses": { "200": { "description": "", "content": { "application/json": {} } } } } }, "/v1/materials/printer-slots/{id}": { "get": { "tags": [], "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" }, { "$ref": "#/components/schemas/PrinterSlot" } ] } } } } } } }, "/v1/materials/{materialId}/variants": { "get": { "tags": [], "parameters": [ { "name": "materialId", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MaterialVariant" } } } } } } } }, "/v1/materials/{id}/profiles": { "post": { "tags": [], "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/modelIdstringnozzleDiameterstringuserProfileIdnullundefinedsystemProfileIdnumber" }, { "$ref": "#/components/schemas/modelIdstringnozzleDiameterstringuserProfileIdCuid2systemProfileIdnullundefined" } ] } } }, "required": true }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MaterialProfileAssignment" } } } } } } }, "delete": { "tags": [], "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClearMaterialProfileRequest" } } }, "required": true }, "responses": { "200": { "description": "", "content": { "application/json": {} } } } } }, "/v1/materials/variants/{variantId}/profiles": { "post": { "tags": [], "parameters": [ { "name": "variantId", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/modelIdstringnozzleDiameterstringuserProfileIdnullundefinedsystemProfileIdnumber" }, { "$ref": "#/components/schemas/modelIdstringnozzleDiameterstringuserProfileIdCuid2systemProfileIdnullundefined" } ] } } }, "required": true }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MaterialProfileAssignment" } } } } } } }, "delete": { "tags": [], "parameters": [ { "name": "variantId", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClearMaterialProfileRequest" } } }, "required": true }, "responses": { "200": { "description": "", "content": { "application/json": {} } } } } }, "/v1/materials/{id}": { "get": { "tags": [], "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Material" } } } } } }, "patch": { "tags": [], "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateMaterialRequest" } } }, "required": true }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Material" } } } } } }, "delete": { "tags": [], "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } } } } }, "/v2/builds": { "post": { "summary": "Create and queue prints", "description": "Create prints containing parts and/or SKUs\n\nThis endpoint allows you to 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": [ "Builds" ], "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/parts": { "get": { "summary": "Get parts with filtering support", "tags": [ "Parts", "MCP" ], "operationId": "parts_getAllV2", "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": "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": "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": 10000 }, "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" } ], "responses": { "200": { "description": "Contains data, metadata, and query information", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchResponse" } } } } } } }, "/v2/parts/search": { "post": { "summary": "Parts search with advanced filtering", "tags": [ "Parts", "MCP" ], "operationId": "searchPartsV2", "parameters": [], "requestBody": { "description": "Complex search query with filter conditions and settings", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchQueryDtoPart" } } }, "required": true }, "responses": { "201": { "description": "Response containing filtered parts data and metadata", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchResponse" } } } } } } }, "/v1/sku-options/values": { "get": { "tags": [], "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SkuOptionValue" } } } } } } }, "post": { "tags": [], "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateSkuOptionValueRequest" } } }, "required": true }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SkuOptionValue" } } } } } } }, "/v1/sku-options/values/{id}": { "get": { "tags": [], "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SkuOptionValue" } } } } } }, "patch": { "tags": [], "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateSkuOptionValueRequest" } } }, "required": true }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SkuOptionValue" } } } } } }, "delete": { "tags": [], "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } } } } }, "/v1/sku-options/values/reorder": { "post": { "tags": [], "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReorderSkuOptionValueRequest" } } }, "required": true }, "responses": { "201": { "description": "", "content": { "application/json": {} } } } } }, "/v1/sku-options/props": { "get": { "tags": [], "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SkuOptionProperty" } } } } } } }, "post": { "tags": [], "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateSkuOptionPropertyRequest" } } }, "required": true }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SkuOptionProperty" } } } } } } }, "/v1/sku-options/props/{id}": { "get": { "tags": [], "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SkuOptionProperty" } } } } } }, "patch": { "tags": [], "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateSkuOptionPropertyRequest" } } }, "required": true }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SkuOptionProperty" } } } } } }, "delete": { "tags": [], "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } } } } }, "/v1/sku-options/prop-values": { "get": { "tags": [], "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SkuOptionPropertyValue" } } } } } } }, "post": { "tags": [], "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkCreatePropertyValuesRequest" } } }, "required": true }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SkuOptionPropertyValue" } } } } } } }, "patch": { "tags": [], "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkUpdatePropertyValuesRequest" } } }, "required": true }, "responses": { "200": { "description": "", "content": { "application/json": {} } } } }, "delete": { "tags": [], "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkDeleteRequest" } } }, "required": true }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } } } } }, "/v1/sku-options/prop-values/{id}": { "get": { "tags": [], "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SkuOptionPropertyValue" } } } } } } }, "/v1/sku-options": { "get": { "tags": [], "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SkuOption" } } } } } } }, "post": { "tags": [], "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateSkuOptionRequest" } } }, "required": true }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SkuOption" } } } } } } }, "/v1/sku-options/{groupId}/values": { "get": { "tags": [], "parameters": [ { "name": "groupId", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SkuOptionValue" } } } } } } } }, "/v1/sku-options/bindings": { "get": { "tags": [], "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SkuOptionBinding" } } } } } } }, "post": { "tags": [], "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateSkuOptionBindingRequest" } } }, "required": true }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SkuOptionBinding" } } } } } } }, "/v1/sku-options/bindings/{id}": { "get": { "tags": [], "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SkuOptionBinding" } } } } } }, "patch": { "tags": [], "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateSkuOptionBindingRequest" } } }, "required": true }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SkuOptionBinding" } } } } } }, "delete": { "tags": [], "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } } } } }, "/v1/sku-options/bindings/reorder": { "post": { "tags": [], "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReorderSkuOptionBindingRequest" } } }, "required": true }, "responses": { "201": { "description": "", "content": { "application/json": {} } } } } }, "/v1/sku-options/{id}": { "get": { "tags": [], "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SkuOption" } } } } } }, "patch": { "tags": [], "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateSkuOptionRequest" } } }, "required": true }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SkuOption" } } } } } }, "delete": { "tags": [], "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } } } } }, "/v1/sku-options/sku-match/{skuString}": { "get": { "tags": [], "parameters": [ { "name": "skuString", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/SkuMatchResult" } ] } } } } } } }, "/v1/api-keys": { "get": { "description": "Get all API keys for a store", "tags": [], "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ApiKey" } } } } } } }, "post": { "description": "Create a new API key", "tags": [], "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateApiKeyRequest" } } }, "required": true }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OneTimeApiKeyInfo" } } } } } } }, "/v1/api-keys/{id}": { "get": { "description": "Find a specific API key", "tags": [], "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiKey" } } } } } }, "patch": { "tags": [], "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateApiKeyRequest" } } }, "required": true }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiKey" } } } } } }, "delete": { "description": "Delete an API key", "tags": [], "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true } ], "responses": { "200": { "description": "", "content": { "application/json": {} } } } } }, "/v1/subscriptions": { "get": { "tags": [], "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Subscription" } } } } } } }, "/v1/subscriptions/commercial-account": { "patch": { "tags": [], "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetCommercialAccountRequest" } } }, "required": true }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Subscription" } } } } } } }, "/v1/storage/signed-urls": { "post": { "tags": [], "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SignedUrlsRequest" } } }, "required": true }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SignedUrlsResponse" } } } } } } }, "/v1/storage/signed-upload-urls": { "post": { "tags": [], "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SignedUploadUrlsRequest" } } }, "required": true }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SignedUploadUrlsResponse" } } } } } } }, "/callbacks/scheduled-task": { "post": { "tags": [], "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExecuteTaskDto" } } }, "required": true }, "responses": { "201": { "description": "", "content": { "application/json": {} } } } } }, "/v1/integrations/bambu/send-verification-code": { "post": { "tags": [], "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BambuSendVerificationCodeRequest" } } }, "required": true }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BambuSendVerificationCodeResponse" } } } } } } }, "/v1/integrations/bambu/auth": { "post": { "tags": [], "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BambuAuthRequest" } } }, "required": true }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/BambuAuthSuccessResponse" }, { "$ref": "#/components/schemas/BambuAuth2FAResponse" } ] } } } } } } }, "/v1/integrations/bambu/tfa": { "post": { "tags": [], "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BambuTfaAuthRequest" } } }, "required": true }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BambuAuthSuccessResponse" } } } } } } }, "/v1/integrations/bambu/profiles": { "post": { "tags": [], "parameters": [], "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BambuImportProfilesResponse" } } } } } } }, "/v1/integrations/bambu/disconnect": { "delete": { "tags": [], "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": {} } } } } }, "/v1/integrations/bambu/connect": { "post": { "tags": [], "parameters": [], "responses": { "201": { "description": "", "content": { "application/json": {} } } } } }, "/v1/settings/notifications": { "get": { "tags": [], "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NotificationSetting" } } } } } } }, "post": { "tags": [], "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/EnableTelegramNotificationsRequest" }, { "$ref": "#/components/schemas/EnablePushoverNotificationsRequest" }, { "$ref": "#/components/schemas/EnableSlackNotificationsRequest" }, { "$ref": "#/components/schemas/EnableWebhookNotificationsRequest" }, { "$ref": "#/components/schemas/EnableDiscordNotificationsRequest" } ], "discriminator": { "propertyName": "channel", "mapping": { "telegram": "#/components/schemas/EnableTelegramNotificationsRequest", "pushover": "#/components/schemas/EnablePushoverNotificationsRequest", "slack": "#/components/schemas/EnableSlackNotificationsRequest", "webhook": "#/components/schemas/EnableWebhookNotificationsRequest", "discord": "#/components/schemas/EnableDiscordNotificationsRequest" } } } } }, "required": true }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationSetting" } } } } } } }, "/v1/settings/notifications/{id}": { "get": { "tags": [], "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationSetting" } } } } } } }, "/v1/settings/notifications/{id}/disable": { "patch": { "tags": [], "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationSetting" } } } } } } }, "/v1/settings/notifications/{id}/configure": { "patch": { "tags": [], "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartialPickNotificationSettingOnFields" } } }, "required": true }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationSetting" } } } } } } }, "/v1/orders": { "get": { "tags": [ "orders" ], "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Order" } } } } } } }, "post": { "tags": [ "orders" ], "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateOrderDto" } } }, "required": true }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderDetailsResponse" } } } } } } }, "/v1/orders/full": { "get": { "tags": [ "orders" ], "parameters": [], "responses": { "200": { "description": "", "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" ] } } } } } } }, "/v1/orders/items": { "get": { "tags": [ "orders" ], "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OrderItem" } } } } } } } }, "/v1/orders/ignored-skus": { "get": { "tags": [ "orders" ], "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IgnoredSku" } } } } } }, "patch": { "tags": [ "orders" ], "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EditIgnoredSkusRequest" } } }, "required": true }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/IgnoredSku" } ] } } } } } } }, "/v1/orders/ignored-skus/check": { "post": { "tags": [ "orders" ], "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CheckIgnoredSkusRequest" } } }, "required": true }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CheckIgnoredSkusResponse" } } } } } } }, "/v1/orders/reconcile": { "post": { "tags": [ "orders" ], "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReconcileJobsRequest" } } }, "required": true }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReconcileJobsResponse" } } } } } } }, "/v1/orders/customers": { "get": { "tags": [ "orders" ], "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Customer" } } } } } } }, "post": { "tags": [ "orders" ], "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateCustomerDto" } } }, "required": true }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Customer" } } } } } } }, "/v1/orders/customers/{customerId}": { "get": { "tags": [ "orders" ], "parameters": [ { "name": "customerId", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Customer" } } } } } } }, "/v1/orders/items/{itemId}": { "get": { "tags": [ "orders" ], "parameters": [ { "name": "itemId", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderItem" } } } } } }, "put": { "tags": [ "orders" ], "parameters": [ { "name": "itemId", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartialOrderItemUpdate" } } }, "required": true }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderItem" } } } } } }, "delete": { "tags": [ "orders" ], "parameters": [ { "name": "itemId", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" } }, "required": [ "id" ] } } } } } } }, "/v1/orders/{orderId}/items": { "get": { "tags": [ "orders" ], "parameters": [ { "name": "orderId", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OrderItem" } } } } } } }, "post": { "tags": [ "orders" ], "parameters": [ { "name": "orderId", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmitOrderItemInsertorderId" } } } }, "required": true }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OrderItem" } } } } } } } }, "/v1/orders/{orderId}/items/batch": { "patch": { "tags": [ "orders" ], "parameters": [ { "name": "orderId", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true } ], "requestBody": { "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": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OrderItem" } } } } } } } }, "/v1/orders/{orderId}/only": { "get": { "tags": [ "orders" ], "parameters": [ { "name": "orderId", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order" } } } } } } }, "/v1/orders/{orderId}": { "get": { "tags": [ "orders" ], "parameters": [ { "name": "orderId", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderDetailsResponse" } } } } } }, "put": { "tags": [ "orders" ], "parameters": [ { "name": "orderId", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartialOrder" } } }, "required": true }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order" } } } } } }, "delete": { "tags": [ "orders" ], "parameters": [ { "name": "orderId", "in": "path", "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "required": true } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" } }, "required": [ "id" ] } } } } } } }, "/v1/integrations/shopify/connect": { "post": { "description": "Connect a Shopify store and generate an API key", "tags": [], "parameters": [], "requestBody": { "description": "The request body containing the JWT", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShopifyConnectRequest" } } }, "required": true }, "responses": { "201": { "description": "API key information for Shopify integration", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OneTimeApiKeyInfo" } } } } } } }, "/v1/integrations/etsy/oauth-url": { "get": { "description": "Generate OAuth URL for Etsy authorization", "tags": [], "parameters": [], "responses": { "200": { "description": "OAuth URL and state", "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string" }, "state": { "type": "string" } }, "required": [ "url", "state" ] } } } } } } }, "/v1/integrations/etsy/connect": { "post": { "description": "Connect an Etsy shop and store OAuth tokens", "tags": [], "parameters": [], "requestBody": { "description": "OAuth token data", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EtsyConnectRequest" } } }, "required": true }, "responses": { "201": { "description": "Integration info", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Integration" } } } } } } }, "/v1/integrations/etsy/sync-orders": { "post": { "description": "Manually sync orders from Etsy", "tags": [], "parameters": [ { "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" } }, "required": [ "orders", "totalSynced" ] } } } } } } }, "/v1/integrations/etsy/status": { "get": { "description": "Get Etsy integration status", "tags": [], "parameters": [], "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" ] } } } } } } }, "/v1/integrations/etsy/disconnect": { "post": { "description": "Disconnect Etsy integration", "tags": [], "parameters": [], "responses": { "201": { "description": "Success message", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } } } } } } }, "/v1/integrations/etsy/listing/{listingId}": { "get": { "description": "Fetch a single listing with inventory", "tags": [], "parameters": [ { "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": {} } } } } } }, "/v1/integrations/etsy/listings-with-inventory": { "get": { "description": "Fetch active listings with their inventory (variations and SKUs) with pagination", "tags": [], "parameters": [ { "name": "page", "in": "query", "schema": { "type": "string" }, "description": " Page number (1-indexed, default: 1)", "required": true }, { "name": "limit", "in": "query", "schema": { "type": "string" }, "description": " Number of listings per page (default: 25, max: 100)", "required": true } ], "responses": { "200": { "description": "Listings with inventory details and pagination metadata", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListingsWithInventory" } } } } } } }, "/v1/integrations/etsy/fetch-all-listings": { "post": { "description": "Fetch all listings in batches (useful for syncing or bulk operations)", "tags": [], "parameters": [ { "name": "batchSize", "in": "query", "schema": { "type": "string" }, "description": " Size of each batch (default: 50, max: 100)", "required": true } ], "responses": { "201": { "description": "All listings with inventory details", "content": { "application/json": { "schema": { "type": "object", "properties": { "listings": { "type": "array", "items": {} }, "totalCount": { "type": "number" }, "fetchDurationMs": { "type": "number" } }, "required": [ "listings", "totalCount", "fetchDurationMs" ] } } } } } } }, "/v1/integrations/etsy/cached-listings": { "get": { "description": "Get cached listings with metadata", "tags": [], "parameters": [ { "name": "forceRefresh", "in": "query", "schema": { "type": "string" }, "description": " Force refresh the cache", "required": true } ], "responses": { "200": { "description": "Cached listings with metadata", "content": { "application/json": { "schema": { "type": "object", "properties": { "listings": { "type": "array", "items": {} }, "cachedAt": { "type": "string", "format": "date-time" }, "expiresAt": { "type": "string", "format": "date-time" }, "isStale": { "type": "boolean" } }, "required": [ "listings", "cachedAt", "expiresAt", "isStale" ] } } } } } } }, "/v1/integrations/etsy/draft-listings": { "get": { "description": "Get draft listings from cache", "tags": [], "parameters": [], "responses": { "200": { "description": "Array of draft listings", "content": { "application/json": { "schema": { "type": "object", "properties": { "listings": { "type": "array", "items": {} }, "count": { "type": "number" } }, "required": [ "listings", "count" ] } } } } } } }, "/v1/integrations/etsy/refresh-draft-listings": { "post": { "description": "Refresh only draft listings in cache", "tags": [], "parameters": [], "responses": { "201": { "description": "Updated draft listings", "content": { "application/json": { "schema": { "type": "object", "properties": { "listings": { "type": "array", "items": {} }, "count": { "type": "number" } }, "required": [ "listings", "count" ] } } } } } } }, "/v1/integrations/etsy/create-draft-listings": { "post": { "description": "Create draft listings from a template", "tags": [], "parameters": [], "requestBody": { "description": "Request body with template listing ID and SKUs", "content": { "application/json": { "schema": { "type": "object", "properties": { "templateListingId": { "type": "number" }, "skus": { "type": "array", "items": { "type": "string" } } }, "required": [ "templateListingId", "skus" ] } } }, "required": true }, "responses": { "201": { "description": "Created listings and any errors", "content": { "application/json": { "schema": { "type": "object", "properties": { "createdListings": { "type": "array", "items": {} }, "errors": { "type": "array", "items": {} } }, "required": [ "createdListings", "errors" ] } } } } } } }, "/v1/integrations/etsy/import-skus": { "post": { "description": "Import Etsy SKUs to Printago", "tags": [], "parameters": [], "requestBody": { "description": "Request body with listing IDs, folder name, and optional section name", "content": { "application/json": { "schema": { "type": "object", "properties": { "listingIds": { "type": "array", "items": { "type": "number" } }, "folderName": { "type": "string" }, "sectionName": { "type": "string" } }, "required": [ "listingIds", "folderName" ] } } }, "required": true }, "responses": { "201": { "description": "Import summary with created/updated SKUs", "content": { "application/json": { "schema": { "type": "object", "properties": { "folderId": { "type": "string" }, "created": { "type": "array", "items": {} }, "updated": { "type": "array", "items": {} }, "errors": { "type": "array", "items": {} } }, "required": [ "folderId", "created", "updated", "errors" ] } } } } } } }, "/v1/integrations/etsy/callback": { "post": { "description": "OAuth callback endpoint for Etsy authorization", "tags": [], "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "state": { "type": "string" }, "error": { "type": "string" } }, "required": [ "code", "state" ] } } }, "required": true }, "responses": { "201": { "description": "HTML response with success/error", "content": { "application/json": { "schema": { "type": "boolean" } } } } } } }, "/v1/sync": { "post": { "tags": [], "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SyncRequest" } } }, "required": true }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SyncResponse" } } } } } } }, "/v1/giveaway/discord-u1-prize": { "get": { "tags": [], "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GiveawayResponse" } } } } } } } }, "components": { "schemas": { "Part": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 1024 }, "type": { "oneOf": [ { "const": "scad" }, { "const": "stl" }, { "const": "step" }, { "const": "3mf" }, { "const": "gcode3mf" } ] }, "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" } ] }, "use3MFProcessProfile": { "type": "boolean" }, "arrangeable": { "type": "boolean" }, "userTags": { "type": "array", "items": { "type": "string" }, "maxItems": 10 }, "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" }, "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" } ] } }, "required": [ "index", "color", "type" ] }, "Metadata3MF": { "type": "object", "properties": { "printerModel": { "type": "string" }, "filamentType": { "type": "array", "items": { "type": "string" } }, "filamentColors": { "type": "array", "items": { "type": "string" } }, "nozzleDiameter": { "type": "string" }, "profileCompat": { "$ref": "#/components/schemas/ProfileCompat" }, "slicerVersion": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/SlicerVersionInfo" } ] }, "plates": { "type": "array", "items": { "$ref": "#/components/schemas/Plate3MF" } } }, "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" }, "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" ] } } } }, "PartInsertWithMaterials": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 1024 }, "type": { "oneOf": [ { "const": "scad" }, { "const": "stl" }, { "const": "step" }, { "const": "3mf" }, { "const": "gcode3mf" } ] }, "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" ] } ] } } }, "PartUpdateWithMaterials": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 1024 }, "type": { "oneOf": [ { "const": "scad" }, { "const": "stl" }, { "const": "step" }, { "const": "3mf" }, { "const": "gcode3mf" } ] }, "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}$" } ] }, "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", "id", "storeId", "createdAt", "updatedAt" ] }, "Printer": { "type": "object", "properties": { "provider": { "oneOf": [ { "const": "OctoPrint" }, { "const": "Prusa" }, { "const": "Bambu" } ] }, "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" } ] }, "proxyClientId": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "commMethod": { "oneOf": [ { "type": "null" }, { "const": "bambu-global-mqtt" }, { "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" } ] }, "continuousPrint": { "type": "boolean" }, "fabmaticRemainingJobs": { "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": [ "provider", "deviceId", "providerConfig", "machineUserProfileId", "machineSystemProfileId", "processUserProfileId", "processSystemProfileId", "name", "nozzleDiameter", "metadata", "proxyClientId", "commMethod", "enabled", "confirmedReady", "isAvailable", "isOnline", "printingJobId", "lastPrintedAt", "integrationId", "integrationType", "continuousPrint", "fabmaticRemainingJobs", "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" } ] } } }, "BambuPrinterMetadata": { "type": "object", "properties": { "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" ] }, "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" ] }, "PrinterStat": { "type": "object", "properties": { "printerId": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "storeId": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "state": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "isOnline": { "type": "boolean" }, "receivedAt": { "type": "string", "format": "date-time" }, "expiresAt": { "type": "string", "format": "date-time" }, "data": { "$ref": "#/components/schemas/PrinterStatData" }, "isAvailable": { "oneOf": [ { "type": "null" }, { "type": "boolean" } ] } }, "required": [ "printerId", "storeId", "state", "isOnline", "receivedAt", "expiresAt", "data", "isAvailable" ] }, "PrinterStatData": { "type": "object", "properties": { "temps": { "type": "object", "properties": { "bedTemp": { "type": "number" }, "bedTempTarget": { "type": "number" }, "nozzleTemp": { "type": "number" }, "nozzleTempTarget": { "type": "number" }, "chamberTemp": { "type": "number" }, "chamberTempTarget": { "type": "number" } } }, "lights": { "type": "object", "properties": { "work": { "type": "string" }, "chamber": { "type": "string" } } }, "fans": { "type": "object", "properties": { "part": { "type": "number" }, "aux": { "type": "number" }, "chamber": { "type": "number" } } }, "printer": { "type": "object", "properties": { "nozzleDiameter": { "type": "string" }, "homeAxes": { "type": "object", "properties": { "x": { "type": "boolean" }, "y": { "type": "boolean" }, "z": { "type": "boolean" } } } }, "required": [ "nozzleDiameter", "homeAxes" ] }, "print": { "type": "object", "properties": { "downloadPercent": { "type": "number" }, "percent": { "type": "number" }, "timeRemaining": { "type": "number" }, "stage": { "type": "string" }, "activity": { "type": "string" }, "errorCode": { "type": "string" }, "printError": { "type": "number" }, "currentLayer": { "type": "number" }, "totalLayers": { "type": "number" }, "taskId": { "type": "string" }, "taskName": { "type": "string" } } }, "filament": { "$ref": "#/components/schemas/LoadedFilament" }, "health": { "$ref": "#/components/schemas/PrinterHealth" } } }, "LoadedFilament": { "type": "object", "properties": { "ams": { "type": "object", "properties": { "status": { "$ref": "#/components/schemas/AMSStatus" }, "ams": { "type": "array", "items": { "$ref": "#/components/schemas/AMS" } } }, "required": [ "status", "ams" ] }, "spool": { "$ref": "#/components/schemas/FilamentInfo" } } }, "AMSStatus": { "type": "object", "properties": { "slotsLoaded": { "type": "string" }, "slotsReading": { "type": "string" } }, "required": [ "slotsLoaded", "slotsReading" ] }, "AMS": { "type": "object", "properties": { "slots": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "string" } }, "required": [ "id" ] }, { "$ref": "#/components/schemas/idstringFilamentInfo" } ] } } }, "required": [ "slots" ] }, "idstringFilamentInfo": { "type": "object", "properties": { "id": { "type": "string" }, "color": { "type": "string", "pattern": "^#{0,1}[0-9A-F]{6}|[0-9A-F]{8}$" }, "info": { "type": "string" }, "tagId": { "type": "string" }, "type": { "oneOf": [ { "const": "" }, { "const": "PLA" }, { "const": "PET" }, { "const": "ABS" }, { "const": "ASA" }, { "const": "FLEX" }, { "const": "HIPS" }, { "const": "EDGE" }, { "const": "NGEN" }, { "const": "PA" }, { "const": "NYLON" }, { "const": "PVA" }, { "const": "PC" }, { "const": "PP" }, { "const": "PEI" }, { "const": "PEEK" }, { "const": "PEKK" }, { "const": "POM" }, { "const": "PSU" }, { "const": "PVDF" }, { "const": "SCAFF" }, { "const": "PETG" }, { "const": "TPU" }, { "const": "TPU-AMS" }, { "const": "PA-CF" }, { "const": "PA6-CF" }, { "const": "PA6-GF" }, { "const": "PLA-CF" }, { "const": "PET-CF" }, { "const": "PETG-CF" }, { "const": "PLA-AERO" }, { "const": "PPS" }, { "const": "PPS-CF" }, { "const": "PPA-CF" }, { "const": "PPA-GF" }, { "const": "PCTG" }, { "const": "ABS-GF" }, { "const": "ASA-Aero" }, { "const": "PE" }, { "const": "PE-CF" }, { "const": "PP-GF" }, { "const": "EVA" }, { "const": "PHA" }, { "const": "BVOH" }, { "const": "PP-CF" } ] }, "remaining": { "type": "number" }, "v": { "type": "string" } }, "required": [ "id", "color", "info", "type", "remaining" ] }, "FilamentInfo": { "type": "object", "properties": { "id": { "type": "string" }, "color": { "type": "string", "pattern": "^#{0,1}[0-9A-F]{6}|[0-9A-F]{8}$" }, "info": { "type": "string" }, "tagId": { "type": "string" }, "type": { "oneOf": [ { "const": "" }, { "const": "PLA" }, { "const": "PET" }, { "const": "ABS" }, { "const": "ASA" }, { "const": "FLEX" }, { "const": "HIPS" }, { "const": "EDGE" }, { "const": "NGEN" }, { "const": "PA" }, { "const": "NYLON" }, { "const": "PVA" }, { "const": "PC" }, { "const": "PP" }, { "const": "PEI" }, { "const": "PEEK" }, { "const": "PEKK" }, { "const": "POM" }, { "const": "PSU" }, { "const": "PVDF" }, { "const": "SCAFF" }, { "const": "PETG" }, { "const": "TPU" }, { "const": "TPU-AMS" }, { "const": "PA-CF" }, { "const": "PA6-CF" }, { "const": "PA6-GF" }, { "const": "PLA-CF" }, { "const": "PET-CF" }, { "const": "PETG-CF" }, { "const": "PLA-AERO" }, { "const": "PPS" }, { "const": "PPS-CF" }, { "const": "PPA-CF" }, { "const": "PPA-GF" }, { "const": "PCTG" }, { "const": "ABS-GF" }, { "const": "ASA-Aero" }, { "const": "PE" }, { "const": "PE-CF" }, { "const": "PP-GF" }, { "const": "EVA" }, { "const": "PHA" }, { "const": "BVOH" }, { "const": "PP-CF" } ] }, "remaining": { "type": "number" }, "v": { "type": "string" } }, "required": [ "color", "info", "type", "remaining" ] }, "PrinterHealth": { "type": "object", "properties": { "errors": { "type": "array", "items": { "$ref": "#/components/schemas/HealthMessage" } }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/HealthMessage" } }, "infos": { "type": "array", "items": { "$ref": "#/components/schemas/HealthMessage" } } }, "required": [ "errors", "warnings", "infos" ] }, "HealthMessage": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message", "code" ] }, "PrinterInsert": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 1024 }, "metadata": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/BambuPrinterMetadata" } ] }, "integrationId": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "integrationType": { "oneOf": [ { "type": "null" }, { "const": "bambulab" }, { "const": "etsy" } ] }, "tags": { "type": "array", "items": { "type": "string" } }, "provider": { "oneOf": [ { "const": "OctoPrint" }, { "const": "Prusa" }, { "const": "Bambu" } ] }, "deviceId": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "nozzleDiameter": { "type": "string" }, "enabled": { "type": "boolean" }, "proxyClientId": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "commMethod": { "oneOf": [ { "type": "null" }, { "const": "bambu-global-mqtt" }, { "const": "octoprint-mqtt" }, { "const": "fuse" } ] } }, "required": [ "name", "metadata", "integrationId", "integrationType", "provider", "deviceId", "nozzleDiameter", "enabled", "proxyClientId", "commMethod" ] }, "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" } ] }, "integrationId": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "integrationType": { "oneOf": [ { "type": "null" }, { "const": "bambulab" }, { "const": "etsy" } ] }, "tags": { "type": "array", "items": { "type": "string" } }, "deviceId": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "nozzleDiameter": { "type": "string" }, "enabled": { "type": "boolean" }, "proxyClientId": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "commMethod": { "oneOf": [ { "type": "null" }, { "const": "bambu-global-mqtt" }, { "const": "octoprint-mqtt" }, { "const": "fuse" } ] } }, "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" } ] }, "integrationId": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "integrationType": { "oneOf": [ { "type": "null" }, { "const": "bambulab" }, { "const": "etsy" } ] }, "tags": { "type": "array", "items": { "type": "string" } }, "deviceId": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "nozzleDiameter": { "type": "string" }, "enabled": { "type": "boolean" }, "proxyClientId": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "commMethod": { "oneOf": [ { "type": "null" }, { "const": "bambu-global-mqtt" }, { "const": "octoprint-mqtt" }, { "const": "fuse" } ] }, "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" } }, "required": [ "plateQuantities" ] }, "PartExtension3MFPlateQuantities": { "type": "object", "properties": {}, "additionalProperties": { "type": "number" } }, "Recordstringstring": { "type": "object", "properties": {}, "description": "Construct a type with a set of properties K of type T", "additionalProperties": { "type": "string" } }, "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" ] }, "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" } ] }, "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" ] }, "Recordstringany": { "type": "object", "properties": {}, "description": "Construct a type with a set of properties K of type T", "additionalProperties": {} }, "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" ] }, "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 } ] }, "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" } ] }, "materialMapping": { "oneOf": [ { "type": "null" }, { "type": "array", "items": { "$ref": "#/components/schemas/PrintJobMaterialMapping" } } ] }, "materialAssignments": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/RecordnumberArraySingleMaterialSpecification" } ] }, "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", "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", "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" ] }, "PrintJobMaterialMapping": { "type": "object", "properties": { "slot": { "type": "number" }, "skip": { "type": "boolean" }, "variantId": { "type": "string" }, "materialId": { "type": "string" }, "materialType": { "type": "string" }, "name": { "type": "string" }, "filamentUserProfileId": { "oneOf": [ { "type": "null" }, { "type": "string", "pattern": "^[a-z0-9]{24}$" } ] }, "filamentSystemProfileId": { "oneOf": [ { "type": "null" }, { "type": "number" } ] } }, "required": [ "slot" ] }, "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" ] } ] } } }, "PrintJobOperationRequest": { "type": "object", "properties": { "printJobIds": { "type": "array", "items": { "type": "string" } } }, "required": [ "printJobIds" ] }, "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" } ] }, "slot": { "type": "number", "minimum": -64, "maximum": 64 }, "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", "slot", "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 }, "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" } ] }, "groupId": { "oneOf": [ { "type": "null" }, { "type": "string", "pattern": "^[a-z0-9]{24}$" } ] }, "index": { "type": "number", "minimum": 0 } }, "required": [ "partId", "priority", "materialId", "variantId", "materialType", "groupId", "index" ] }, "DetailDataMatched": { "type": "object", "properties": { "slots": { "type": "array", "items": { "$ref": "#/components/schemas/PrinterSlot" } } }, "required": [ "slots" ] }, "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" ] }, "AcknowledgePrintJobStartRequest": { "type": "object", "properties": { "startedSuccessfully": { "type": "boolean" }, "errorDetail": { "type": "string" } }, "required": [ "startedSuccessfully" ] }, "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 }, "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}$" } ] }, "skuInstance": { "oneOf": [ { "type": "null" }, { "type": "number" } ] } }, "description": "Make all properties in T optional" }, "Store": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 1024 }, "id": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "updatedAt": { "type": "string", "format": "date-time" }, "createdAt": { "type": "string", "format": "date-time" } }, "required": [ "name", "id", "updatedAt", "createdAt" ] }, "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}$" } ] }, "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", "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" ] }, "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}$" } ] }, "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", "id", "storeId", "createdAt", "updatedAt", "linkedParts" ] }, "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" }, "BuildResult": { "type": "object", "properties": { "partBuilds": { "type": "array", "items": { "$ref": "#/components/schemas/PartBuild" } }, "skuBuilds": { "type": "array", "items": { "$ref": "#/components/schemas/SkuBuild" } } }, "required": [ "partBuilds", "skuBuilds" ] }, "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": "stl" }, { "const": "step" }, { "const": "3mf" }, { "const": "gcode3mf" } ] }, "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" }, "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" } ] } }, "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" } }, "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" }, "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" ] } } }, "required": [ "printerModel", "filamentType", "filamentColors", "nozzleDiameter", "profileCompat" ] } ] }, "use3MFProcessProfile": { "type": "boolean" }, "arrangeable": { "type": "boolean" }, "userTags": { "type": "array", "items": { "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 } ] }, "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}$" } ] }, "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", "orderId", "orderItemId", "linkedPartId", "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" } }, "required": [ "plateQuantities" ] }, "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}$" } ] }, "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", "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" } ] } }, "BuildConfig": { "type": "object", "properties": { "parts": { "type": "array", "items": { "$ref": "#/components/schemas/PartBuildConfig" } }, "skus": { "type": "array", "items": { "$ref": "#/components/schemas/SkuBuildConfig" } } } }, "PartBuildConfig": { "type": "object", "properties": { "partId": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "skuBuildId": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "label": { "type": "string", "minLength": 1, "maxLength": 1024 }, "tags": { "$ref": "#/components/schemas/Tags" }, "quantity": { "type": "number", "minimum": 0, "maximum": 500 }, "quantitySkip": { "type": "number" }, "parameterOverrides": { "type": "array", "items": { "$ref": "#/components/schemas/PartParameterOverride" } }, "extensions": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/PartBuildExtensions" } ] }, "materialAssignments": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/RecordnumberArraySingleMaterialSpecification" } ] }, "priority": { "oneOf": [ { "const": 100 }, { "const": 1000 } ] }, "order": { "type": "object", "properties": { "orderId": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "orderItemId": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "linkedPartId": { "oneOf": [ { "type": "null" }, { "type": "string", "pattern": "^[a-z0-9]{24}$" } ] }, "skuId": { "type": "string", "pattern": "^[a-z0-9]{24}$" } }, "required": [ "orderId", "orderItemId", "linkedPartId", "skuId" ] }, "numPartsPerSku": { "type": "number" }, "skuInstanceStart": { "type": "number" } }, "required": [ "partId", "quantity" ] }, "SkuBuildConfig": { "type": "object", "properties": { "skuId": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "label": { "type": "string", "minLength": 1, "maxLength": 1024 }, "tags": { "$ref": "#/components/schemas/Tags" }, "quantity": { "type": "number", "minimum": 0, "maximum": 500 }, "parts": { "type": "array", "items": { "$ref": "#/components/schemas/SkuPartBuildConfig" } }, "priority": { "oneOf": [ { "const": 100 }, { "const": 1000 } ] }, "skuInstanceStart": { "type": "number" }, "selectedOptions": { "$ref": "#/components/schemas/Recordstringstringnull" }, "order": { "type": "object", "properties": { "orderId": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "orderItemId": { "type": "string", "pattern": "^[a-z0-9]{24}$" } }, "required": [ "orderId", "orderItemId" ] } }, "required": [ "skuId", "quantity", "parts" ] }, "SkuPartBuildConfig": { "type": "object", "properties": { "tags": { "$ref": "#/components/schemas/Tags" }, "order": { "type": "object", "properties": { "orderId": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "orderItemId": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "linkedPartId": { "oneOf": [ { "type": "null" }, { "type": "string", "pattern": "^[a-z0-9]{24}$" } ] }, "skuId": { "type": "string", "pattern": "^[a-z0-9]{24}$" } }, "required": [ "orderId", "orderItemId", "linkedPartId", "skuId" ] }, "partId": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "skuInstanceStart": { "type": "number" }, "quantity": { "type": "number", "minimum": 0, "maximum": 500 }, "priority": { "oneOf": [ { "const": 100 }, { "const": 1000 } ] }, "skuBuildId": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "label": { "type": "string", "minLength": 1, "maxLength": 1024 }, "numPartsPerSku": { "type": "number" }, "parameterOverrides": { "type": "array", "items": { "$ref": "#/components/schemas/PartParameterOverride" } }, "extensions": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/PartBuildExtensions" } ] }, "quantitySkip": { "type": "number" }, "materialAssignments": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/RecordnumberArrayLinkedPartMaterialSpecification" } ] } }, "required": [ "partId", "quantity" ] }, "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": "stl" }, { "const": "step" }, { "const": "3mf" }, { "const": "gcode3mf" } ] }, "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" }, "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" } ] } }, "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" } }, "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" }, "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" ] } } }, "required": [ "printerModel", "filamentType", "filamentColors", "nozzleDiameter", "profileCompat" ] } ] }, "use3MFProcessProfile": { "type": "boolean" }, "arrangeable": { "type": "boolean" }, "userTags": { "type": "array", "items": { "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 } ] }, "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}$" } ] }, "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", "orderId", "orderItemId", "linkedPartId", "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" } ] }, "inputFiles": { "type": "array", "items": { "type": "string" }, "minItems": 1 }, "inputParameters": { "$ref": "#/components/schemas/OpenSCADInputParameters" }, "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" } ] }, "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", "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" ] } } } }, "UserStoresRelation": { "type": "object", "properties": { "id": { "type": "string" }, "email": { "type": "string" }, "stores": { "type": "array", "items": { "$ref": "#/components/schemas/Store" } } }, "required": [ "id", "stores" ] }, "UserInsert": { "type": "object", "properties": { "email": { "type": "string", "format": "email" }, "password": { "type": "string" }, "termsAccepted": { "type": "boolean" }, "recaptchaToken": { "type": "string" } }, "required": [ "email", "password", "termsAccepted", "recaptchaToken" ] }, "Integration": { "type": "object", "properties": { "type": { "oneOf": [ { "const": "bambulab" }, { "const": "etsy" } ] }, "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" ] }, "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}$" } ] }, "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", "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": "stl" }, { "const": "step" }, { "const": "3mf" }, { "const": "gcode3mf" } ] }, "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" }, "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" } ] } }, "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" } }, "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" }, "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" ] } } }, "required": [ "printerModel", "filamentType", "filamentColors", "nozzleDiameter", "profileCompat" ] } ] }, "use3MFProcessProfile": { "type": "boolean" }, "arrangeable": { "type": "boolean" }, "userTags": { "type": "array", "items": { "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 } ] }, "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}$" } ] }, "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", "orderId", "orderItemId", "linkedPartId", "id", "storeId", "createdAt", "updatedAt", "printJobs", "steps" ] }, "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" ] }, "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" ] }, "GetAllPermissionsForUserResponse": { "type": "object", "properties": { "owner": { "type": "boolean" }, "permissions": { "type": "array", "items": { "$ref": "#/components/schemas/GetUserPermissionResponse" } } }, "required": [ "owner", "permissions" ] }, "GetUserPermissionResponse": { "type": "object", "properties": { "userId": { "type": "string" }, "permission": { "oneOf": [ { "const": "store.owner" }, { "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" ] }, "WebInitData": { "type": "object", "properties": { "permissions": { "$ref": "#/components/schemas/GetAllPermissionsForUserResponse" }, "subscriptions": { "type": "array", "items": { "$ref": "#/components/schemas/Subscription" } }, "integrations": { "type": "array", "items": { "$ref": "#/components/schemas/Integration" } }, "myPrinterModels": { "type": "array", "items": { "$ref": "#/components/schemas/PrinterModel" } } }, "required": [ "permissions", "subscriptions", "integrations", "myPrinterModels" ] }, "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" ] }, "SendCommandRequest": { "type": "object", "properties": { "command": { "oneOf": [ { "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 }, "targetSlotId": { "type": "number" } }, "required": [ "command", "targetTemp", "currentTemp", "targetSlotId" ] }, { "type": "object", "properties": { "command": { "const": "led-control" }, "light": { "oneOf": [ { "const": "chamber_light" }, { "const": "working_light" } ] }, "state": { "oneOf": [ { "const": "on" }, { "const": "off" } ] } }, "required": [ "command", "light", "state" ] }, { "type": "object", "properties": { "command": { "const": "set-temperature" }, "type": { "oneOf": [ { "const": "nozzle" }, { "const": "bed" }, { "const": "chamber" } ] }, "temperature": { "type": "number", "minimum": 0, "maximum": 300 } }, "required": [ "command", "type", "temperature" ] }, { "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" }, "type": { "oneOf": [ { "const": "part" }, { "const": "chamber" }, { "const": "aux" } ] }, "speed": { "type": "number", "minimum": 0, "maximum": 100 } }, "required": [ "command", "type", "speed" ] }, { "type": "object", "properties": { "command": { "const": "extrude-filament" }, "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": "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" ] } ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^[a-z0-9]{24}$" } } }, "required": [ "command", "ids" ] }, "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" }, "currency": { "oneOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": [ "id", "storeId", "createdAt", "updatedAt", "slicer", "processLowPriorityJobs", "currency" ] }, "UpdateStoreSettingsRequest": { "type": "object", "properties": { "slicer": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "processLowPriorityJobs": { "type": "boolean" }, "currency": { "oneOf": [ { "type": "null" }, { "type": "string" } ] } } }, "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" ] }, "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" }, "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" }, "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" } ] }, "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 }, "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" } }, "required": [ "name", "brand", "type", "tags", "filamentUserProfileId", "filamentSystemProfileId" ] }, "MaterialVariantInsert": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "tags": { "type": "array", "items": { "type": "string" } }, "filamentUserProfileId": { "oneOf": [ { "type": "null" }, { "type": "string", "pattern": "^[a-z0-9]{24}$" } ] }, "filamentSystemProfileId": { "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}))*$" } ] } }, "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" } ] }, "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" ] }, "PartMaterialAssignmentInsert": { "type": "object", "properties": { "partId": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "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}$" } ] }, "materialType": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "groupId": { "oneOf": [ { "type": "null" }, { "type": "string", "pattern": "^[a-z0-9]{24}$" } ] }, "index": { "type": "number", "minimum": 0 } }, "required": [ "partId", "priority", "materialId", "variantId", "materialType", "groupId", "index" ] }, "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 }, "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": { "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 }, "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" }, "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" ] }, "printerIdsCuid2slotsnumbersetOnPrinterbooleanundefinedmaterialTypestringfilamentUserProfileIdCuid2nullundefinedfilamentSystemProfileIdnumber...1more...undefinedvariantIdnullundefinedmaterialIdnullundefinedinstanceIdnullundefined": { "type": "object", "properties": { "printerIds": { "type": "array", "items": { "type": "string", "pattern": "^[a-z0-9]{24}$" } }, "slots": { "type": "array", "items": { "type": "number" } }, "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", "slots", "materialType" ] }, "printerIdsCuid2slotsnumbersetOnPrinterbooleanundefinedinstanceIdCuid2filamentUserProfileIdCuid2nullundefinedfilamentSystemProfileIdnumber...1more...undefinedvariantIdnullundefinedmaterialIdnullundefinedmaterialTypenullundefined": { "type": "object", "properties": { "printerIds": { "type": "array", "items": { "type": "string", "pattern": "^[a-z0-9]{24}$" } }, "slots": { "type": "array", "items": { "type": "number" } }, "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", "slots", "instanceId" ] }, "printerIdsCuid2slotsnumbersetOnPrinterbooleanundefinedvariantIdCuid2filamentUserProfileIdCuid2nullundefinedfilamentSystemProfileIdnumber...1more...undefinedinstanceIdnullundefinedmaterialIdnullundefinedmaterialTypenullundefined": { "type": "object", "properties": { "printerIds": { "type": "array", "items": { "type": "string", "pattern": "^[a-z0-9]{24}$" } }, "slots": { "type": "array", "items": { "type": "number" } }, "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", "slots", "variantId" ] }, "printerIdsCuid2slotsnumbersetOnPrinterbooleanundefinedmaterialIdCuid2filamentUserProfileIdCuid2nullundefinedfilamentSystemProfileIdnumber...1more...undefinedinstanceIdnullundefinedvariantIdnullundefinedmaterialTypenullundefined": { "type": "object", "properties": { "printerIds": { "type": "array", "items": { "type": "string", "pattern": "^[a-z0-9]{24}$" } }, "slots": { "type": "array", "items": { "type": "number" } }, "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", "slots", "materialId" ] }, "SetSlotProfileRequest": { "type": "object", "properties": { "printerIds": { "type": "array", "items": { "type": "string", "pattern": "^[a-z0-9]{24}$" } }, "slot": { "type": "number" }, "filamentUserProfileId": { "oneOf": [ { "type": "null" }, { "type": "string", "pattern": "^[a-z0-9]{24}$" } ] }, "filamentSystemProfileId": { "oneOf": [ { "type": "null" }, { "type": "number" } ] } }, "required": [ "printerIds", "slot" ] }, "ClearPrinterSlotRequest": { "type": "object", "properties": { "printerIds": { "type": "array", "items": { "type": "string", "pattern": "^[a-z0-9]{24}$" } }, "slots": { "type": "array", "items": { "type": "number" } }, "setOnPrinter": { "type": "boolean" } }, "required": [ "printerIds", "slots" ] }, "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" } } }, "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" }, "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...4more...optionsSkuOptionSpecundefined" }, { "$ref": "#/components/schemas/skustringquantityQuantityMin1undefinedlinkedPartConfigsRecordCuid2LinkedPartConfigV2undefined...4more...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" }, "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" }, "materials": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/RecordnumberArraySingleMaterialSpecification" } ], "description": "Material assignments per extruder/channel (channel index -> material specifications)" } }, "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...4more...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" }, "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": { "tags": { "$ref": "#/components/schemas/Tags", "description": "Tags to categorize or filter this part" }, "parameters": { "$ref": "#/components/schemas/Parameters", "description": "Custom parameters to override part defaults" }, "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" }, "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...4more...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" }, "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" ] }, "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" }, "SimpleSearchQueryDtoPart": { "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" }, "use3MFProcessProfile": { "type": "string" }, "arrangeable": { "type": "string" }, "userTags": { "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\". Example: \"name:asc,createdAt:desc\"" }, "limit": { "type": "number", "minimum": 1, "maximum": 10000, "title": "Limit", "description": "Maximum number of results to return. Minimum: 1, Maximum: 10000, Default: 10000." }, "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 specific fields to return. If not provided, all fields are returned. Always includes `id` and `storeId`. Example: \"name,description\"\n]" } }, "title": "Simple Search Query", "description": "Simplified search using dot notation for field access with query settings, e.g. ?name.contains=benchy&type.eq=3mf" }, "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\". Example: \"name:asc,createdAt:desc\"" }, "limit": { "type": "number", "minimum": 1, "maximum": 10000, "title": "Limit", "description": "Maximum number of results to return. Minimum: 1, Maximum: 10000, Default: 10000." }, "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 specific fields to return. If not provided, all fields are returned. Always includes `id` and `storeId`. Example: \"name,description\"\n]" } }, "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" }, "use3MFProcessProfile": { "$ref": "#/components/schemas/FieldOperators" }, "arrangeable": { "$ref": "#/components/schemas/FieldOperators" }, "userTags": { "$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" }, "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}$" }, "name": { "type": "string" }, "type": { "oneOf": [ { "const": "text" }, { "const": "material" }, { "const": "plate_quantities" } ] }, "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", "id", "storeId", "createdAt", "updatedAt" ] }, "CreateSkuOptionPropertyRequest": { "type": "object", "properties": { "optionId": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "name": { "type": "string" }, "type": { "oneOf": [ { "const": "text" }, { "const": "material" }, { "const": "plate_quantities" } ] } }, "required": [ "optionId", "name", "type" ] }, "UpdateSkuOptionPropertyRequest": { "type": "object", "properties": { "name": { "type": "string" } } }, "SkuOptionPropertyValue": { "type": "object", "properties": { "optionValueId": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "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" } ] }, "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": [ "optionValueId", "propertyId", "textValue", "materialValue", "plateQuantitiesValue", "id", "storeId", "createdAt", "updatedAt" ] }, "Recordstringnumber": { "type": "object", "properties": {}, "description": "Construct a type with a set of properties K of type T", "additionalProperties": { "type": "number" } }, "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}$" }, "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", "textValue", "materialValue", "plateQuantitiesValue" ] }, "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" ] }, "SkuOptionBinding": { "type": "object", "properties": { "optionId": { "type": "string", "pattern": "^[a-z0-9]{24}$" }, "skuId": { "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": [ "optionId", "skuId", "order", "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" } } }, "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" } } }, "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" ] }, "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" } ] }, "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", "id", "storeId", "createdAt", "updatedAt" ] }, "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" } }, "required": [ "name" ] }, "UpdateApiKeyRequest": { "type": "object", "properties": { "active": { "type": "boolean" }, "name": { "type": "string", "minLength": 1 } } }, "SetCommercialAccountRequest": { "type": "object", "properties": { "isCommercial": { "type": "boolean" } }, "required": [ "isCommercial" ] }, "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" } }, "required": [ "path", "uploadUrl" ] } } }, "required": [ "signedUrls" ] }, "SignedUploadUrlsRequest": { "type": "object", "properties": { "filenames": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 1024 } } }, "required": [ "filenames" ] }, "ExecuteTaskDto": { "type": "object", "properties": { "taskType": { "type": "string" }, "payload": { "$ref": "#/components/schemas/Recordstringany" }, "taskId": { "type": "string" } }, "required": [ "taskType", "payload" ] }, "BambuSendVerificationCodeResponse": { "type": "object", "properties": { "codeSent": { "type": "boolean" } }, "required": [ "codeSent" ] }, "BambuSendVerificationCodeRequest": { "type": "object", "properties": { "email": { "type": "string", "format": "email" } }, "required": [ "email" ] }, "BambuAuthSuccessResponse": { "type": "object", "properties": { "devices": { "type": "array", "items": { "$ref": "#/components/schemas/BambuLabPrinter" } }, "profiles": { "$ref": "#/components/schemas/BambuLabProfileList" } }, "required": [ "devices", "profiles" ] }, "BambuLabPrinter": { "type": "object", "properties": { "dev_access_code": { "type": "string" }, "dev_id": { "type": "string" }, "dev_model_name": { "type": "string" }, "dev_product_name": { "type": "string" }, "name": { "type": "string" }, "nozzle_diameter": { "type": "number" }, "online": { "type": "boolean" }, "print_status": { "type": "string" } }, "required": [ "dev_access_code", "dev_id", "dev_model_name", "dev_product_name", "name", "nozzle_diameter", "online", "print_status" ] }, "BambuLabProfileList": { "type": "object", "properties": { "print": { "type": "object", "properties": { "system": { "type": "array", "items": { "$ref": "#/components/schemas/BambuLabProfile" } }, "user": { "type": "array", "items": { "$ref": "#/components/schemas/BambuLabProfile" } } }, "required": [ "system", "user" ] }, "printer": { "type": "object", "properties": { "system": { "type": "array", "items": { "$ref": "#/components/schemas/BambuLabProfile" } }, "user": { "type": "array", "items": { "$ref": "#/components/schemas/BambuLabProfile" } } }, "required": [ "system", "user" ] }, "filament": { "type": "object", "properties": { "system": { "type": "array", "items": { "$ref": "#/components/schemas/BambuLabProfile" } }, "user": { "type": "array", "items": { "$ref": "#/components/schemas/BambuLabProfile" } } }, "required": [ "system", "user" ] } }, "required": [ "print", "printer", "filament" ] }, "BambuLabProfile": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "updatedAt": { "type": "string" }, "version": { "type": "string" } }, "required": [ "id", "name", "updatedAt", "version" ] }, "BambuAuth2FAResponse": { "type": "object", "properties": { "loginType": { "type": "string" }, "tfaKey": { "type": "string" } }, "required": [ "loginType" ] }, "BambuAuthRequest": { "type": "object", "properties": { "email": { "type": "string", "format": "email" }, "password": { "type": "string", "minLength": 2 }, "code": { "type": "string" } } }, "BambuTfaAuthRequest": { "type": "object", "properties": { "tfaCode": { "type": "string" }, "tfaKey": { "type": "string" } }, "required": [ "tfaCode", "tfaKey" ] }, "BambuImportProfilesResponse": { "type": "object", "properties": { "importedIds": { "type": "array", "items": { "type": "string" } } }, "required": [ "importedIds" ] }, "NotificationSetting": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "channel": { "oneOf": [ { "const": "discord" }, { "const": "webhook" }, { "const": "slack" }, { "const": "pushover" }, { "const": "telegram" } ] }, "onJobSucceeded": { "type": "boolean" }, "onJobFailed": { "type": "boolean" }, "onJobStarted": { "type": "boolean" }, "onJobCancelled": { "type": "boolean" }, "onPrinterHmsError": { "type": "boolean" }, "onPrinterHmsWarning": { "type": "boolean" }, "onPrinterOffline": { "type": "boolean" }, "onPrinterOnline": { "type": "boolean" }, "onPrinterContinuousPrintDisabled": { "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": [ "enabled", "channel", "onJobSucceeded", "onJobFailed", "onJobStarted", "onJobCancelled", "onPrinterHmsError", "onPrinterHmsWarning", "onPrinterOffline", "onPrinterOnline", "onPrinterContinuousPrintDisabled", "id", "storeId", "createdAt", "updatedAt" ] }, "EnableTelegramNotificationsRequest": { "type": "object", "properties": { "channel": { "const": "telegram" }, "data": { "type": "object", "properties": { "botToken": { "type": "string" }, "chatId": { "type": "string" } }, "required": [ "botToken", "chatId" ] } }, "required": [ "channel", "data" ] }, "EnablePushoverNotificationsRequest": { "type": "object", "properties": { "channel": { "const": "pushover" }, "data": { "type": "object", "properties": { "appToken": { "type": "string" }, "userKey": { "type": "string" }, "device": { "type": "string" }, "priority": { "oneOf": [ { "const": -2 }, { "const": -1 }, { "const": 0 }, { "const": 1 }, { "const": 2 } ] }, "sound": { "type": "string" } }, "required": [ "appToken", "userKey" ] } }, "required": [ "channel", "data" ] }, "EnableSlackNotificationsRequest": { "type": "object", "properties": { "channel": { "const": "slack" }, "data": { "type": "object", "properties": { "webhookUrl": { "type": "string", "format": "url" } }, "required": [ "webhookUrl" ] } }, "required": [ "channel", "data" ] }, "EnableWebhookNotificationsRequest": { "type": "object", "properties": { "channel": { "const": "webhook" }, "data": { "type": "object", "properties": { "webhookUrl": { "type": "string", "format": "url" }, "apiKey": { "type": "string" } }, "required": [ "webhookUrl", "apiKey" ] } }, "required": [ "channel", "data" ] }, "EnableDiscordNotificationsRequest": { "type": "object", "properties": { "channel": { "const": "discord" }, "data": { "type": "object", "properties": { "webhookUrl": { "type": "string", "format": "url" } }, "required": [ "webhookUrl" ] } }, "required": [ "channel", "data" ] }, "PartialPickNotificationSettingOnFields": { "type": "object", "properties": { "onJobSucceeded": { "type": "boolean" }, "onJobFailed": { "type": "boolean" }, "onJobCancelled": { "type": "boolean" }, "onJobStarted": { "type": "boolean" }, "onPrinterHmsError": { "type": "boolean" }, "onPrinterHmsWarning": { "type": "boolean" }, "onPrinterOffline": { "type": "boolean" }, "onPrinterOnline": { "type": "boolean" }, "onPrinterContinuousPrintDisabled": { "type": "boolean" } }, "description": "Make all properties in T optional" }, "Order": { "type": "object", "properties": { "orderNumber": { "type": "string", "minLength": 1 }, "source": { "oneOf": [ { "type": "null" }, { "const": "etsy" }, { "const": "shopify" }, { "const": "manual" } ] }, "status": { "oneOf": [ { "const": "open" }, { "const": "closed" } ] }, "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" } ] }, "externalId": { "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" } ] }, "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", "id", "storeId", "createdAt", "updatedAt" ], "description": "Order entity representing a retail order" }, "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" } ] }, "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" } ] }, "processedAt": { "oneOf": [ { "type": "null" }, { "type": "string", "format": "date-time" } ] }, "ignored": { "oneOf": [ { "type": "null" }, { "type": "boolean" } ] }, "processedStatus": { "oneOf": [ { "type": "null" }, { "const": "unprocessed" }, { "const": "processed" } ] }, "skuConfig": { "$ref": "#/components/schemas/OrderItemSkuConfig" }, "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", "skuConfig", "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" }, "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" } ] }, "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/OmitOrderItemInsertorderId" } } }, "required": [ "order" ] }, "OrderInsert": { "type": "object", "properties": { "externalId": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "source": { "oneOf": [ { "type": "null" }, { "const": "etsy" }, { "const": "shopify" }, { "const": "manual" } ] }, "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" } ] } }, "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" } ] }, "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" } ] } } }, "OmitOrderItemInsertorderId": { "type": "object", "properties": { "externalId": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "source": { "oneOf": [ { "type": "null" }, { "const": "etsy" }, { "const": "shopify" }, { "const": "manual" } ] }, "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" } ] }, "processedStatus": { "oneOf": [ { "type": "null" }, { "const": "unprocessed" }, { "const": "processed" } ] }, "ignored": { "oneOf": [ { "type": "null" }, { "type": "boolean" } ] }, "skuConfig": { "$ref": "#/components/schemas/OrderItemSkuConfig" } }, "required": [ "skuId", "quantity", "skuConfig" ], "description": "Construct a type with the properties of T except for those in type K." }, "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 } ] } }, "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" } ] } } }, "PartialOrderItemUpdate": { "type": "object", "properties": { "externalId": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "source": { "oneOf": [ { "type": "null" }, { "const": "etsy" }, { "const": "shopify" }, { "const": "manual" } ] }, "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" } ] }, "processedStatus": { "oneOf": [ { "type": "null" }, { "const": "unprocessed" }, { "const": "processed" } ] }, "ignored": { "oneOf": [ { "type": "null" }, { "type": "boolean" } ] }, "skuConfig": { "$ref": "#/components/schemas/OrderItemSkuConfig" } }, "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" } ] }, "status": { "oneOf": [ { "const": "open" }, { "const": "closed" } ] }, "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" } ] }, "externalId": { "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" } ] }, "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" }, "ShopifyConnectRequest": { "type": "object", "properties": { "shop": { "type": "string" }, "token": { "type": "string" } }, "required": [ "shop", "token" ] }, "EtsyConnectRequest": { "type": "object", "properties": { "access_token": { "type": "string" }, "refresh_token": { "type": "string" }, "token_type": { "type": "string" }, "expires_in": { "type": "number" }, "shop_id": { "type": "number" }, "user_id": { "type": "number" } }, "required": [ "access_token", "refresh_token", "token_type", "expires_in" ], "description": "Etsy Connect Request (for OAuth flow)" }, "PaginatedListingsWithInventory": { "type": "object", "properties": { "listings": { "type": "array", "items": {} }, "pagination": { "$ref": "#/components/schemas/PaginationMetadata" } }, "required": [ "listings", "pagination" ], "description": "Paginated listings response with inventory" }, "PaginationMetadata": { "type": "object", "properties": { "page": { "type": "number" }, "limit": { "type": "number" }, "totalCount": { "type": "number" }, "totalPages": { "type": "number" }, "hasMore": { "type": "boolean" } }, "required": [ "page", "limit", "totalCount", "totalPages", "hasMore" ], "description": "Pagination metadata for listing responses" }, "SyncResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/RecordstringArrayany" }, "deleted": { "$ref": "#/components/schemas/RecordstringArraystring" }, "cursors": { "$ref": "#/components/schemas/RecordstringSyncCursor" }, "hasMore": { "type": "boolean" }, "fullSyncRequired": { "type": "boolean" } }, "required": [ "data", "deleted", "cursors", "hasMore" ] }, "RecordstringArrayany": { "type": "object", "properties": {}, "description": "Construct a type with a set of properties K of type T", "additionalProperties": { "type": "array", "items": {} } }, "RecordstringArraystring": { "type": "object", "properties": {}, "description": "Construct a type with a set of properties K of type T", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "RecordstringSyncCursor": { "type": "object", "properties": {}, "description": "Construct a type with a set of properties K of type T", "additionalProperties": { "$ref": "#/components/schemas/SyncCursor" } }, "SyncCursor": { "type": "object", "properties": { "timestamp": { "type": "string" }, "version": { "type": "number" }, "lastId": { "type": "string" } }, "required": [ "timestamp", "version" ] }, "SyncRequest": { "type": "object", "properties": { "cursors": { "$ref": "#/components/schemas/RecordstringSyncCursor" }, "limit": { "type": "number" }, "includeDeleted": { "type": "boolean" }, "entityTypes": { "type": "array", "items": { "type": "string" } } } }, "GiveawayResponse": { "type": "object", "properties": { "code": { "type": "string" } }, "required": [ "code" ] } }, "securitySchemes": { "bearer": { "type": "apiKey", "name": "Authorization", "in": "header" } } }, "tags": [ { "name": "Builds" }, { "name": "Parts" }, { "name": "MCP" }, { "name": "orders" } ], "x-samchon-emended": true }