Skip to content
Stella ConnectDocs
Nesting

Create a nest

POST{baseUrl}/v0.1-alpha/nesting/nest

Creates a Nest from a set of parts. Need to turn a file into parts? Check out Import Part.

Authx-api-key

application/json
Field
Type
Required
Description
outputLengthUnitstringNo

The unit of measurement for output lengths.

outputTimeUnitstringNo

The unit of measurement for output times.

outputWeightUnitstringNo

The unit of measurement for output weights.

nestingOptionsobjectYes
nestingOptions.keepRemnantbooleanNo
nestingOptions.horizontalRemnantPercentagenumberNo
nestingOptions.verticalRemnantPercentagenumberNo
nestingOptions.horizontalCropnumberNo
nestingOptions.verticalCropnumberNo
nestingOptions.edgeDistancenumberNo
nestingOptions.partClearancenumberNo
nestingOptions.bottomDeadZonenumberNo
nestingOptions.leftDeadZonenumberNo
nestingOptions.deadZoneUnitstringNo
nestingOptions.scrapPercentagenumberNo
parts[]object[]Yes
parts[].partIduuidNo
parts[].partNamestringNo
parts[].measurementUnitstringNo
parts[].scaleToMeasurementUnitbooleanNo
parts[].grainbooleanNo
parts[].quantityintegerNo
sheetOptionsobjectYes
sheetOptions.namestringNo
sheetOptions.productIdstringNo
sheetOptions.materialTypestringNo
sheetOptions.densitynumberNo
sheetOptions.densityUnitstringNo
sheetOptions.thicknessnumberNo
sheetOptions.lengthUnitstringNo
sheetOptions.sizes[]object[]No
sheetOptions.sizes[].variantIdstringNo
sheetOptions.sizes[].measurementUnitstringNo
sheetOptions.sizes[].lengthnumberNo
sheetOptions.sizes[].widthnumberNo
sheetOptions.sizes[].quantityintegerNo
measurementUnitstringNo
imageHeightintegerYes
imageWidthintegerYes
croppingOptionsobjectNo
croppingOptions.fillColorstringNo
croppingOptions.hatchStyleenum | nullNo
Show 53 values
"Horizontal""Vertical""ForwardDiagonal""BackwardDiagonal""Cross""DiagonalCross""Percent05""Percent10""Percent20""Percent25""Percent30""Percent40""Percent50""Percent60""Percent70""Percent75""Percent80""Percent90""LightDownwardDiagonal""LightUpwardDiagonal""DarkDownwardDiagonal""DarkUpwardDiagonal""WideDownwardDiagonal""WideUpwardDiagonal""LightVertical""LightHorizontal""NarrowVertical""NarrowHorizontal""DarkVertical""DarkHorizontal""DashedDownwardDiagonal""DashedUpwardDiagonal""DashedHorizontal""DashedVertical""SmallConfetti""LargeConfetti""ZigZag""Wave""DiagonalBrick""HorizontalBrick""Weave""Plaid""Divot""DottedGrid""DottedDiamond""Shingle""Trellis""Sphere""SmallGrid""SmallCheckerBoard""LargeCheckerBoard""OutlinedDiamond""SolidDiamond"
croppingOptions.strokeColorstringNo
croppingOptions.strokeStyleenumNo
"Solid""Dash""Dot""DashDot""DashDotDot""Custom"
croppingOptions.cropLengthnumberNo
croppingOptions.cropWidthnumberNo
deadZoneOptionsobjectNo
deadZoneOptions.fillColorstringNo
deadZoneOptions.hatchStyleenum | nullNo
Show 53 values
"Horizontal""Vertical""ForwardDiagonal""BackwardDiagonal""Cross""DiagonalCross""Percent05""Percent10""Percent20""Percent25""Percent30""Percent40""Percent50""Percent60""Percent70""Percent75""Percent80""Percent90""LightDownwardDiagonal""LightUpwardDiagonal""DarkDownwardDiagonal""DarkUpwardDiagonal""WideDownwardDiagonal""WideUpwardDiagonal""LightVertical""LightHorizontal""NarrowVertical""NarrowHorizontal""DarkVertical""DarkHorizontal""DashedDownwardDiagonal""DashedUpwardDiagonal""DashedHorizontal""DashedVertical""SmallConfetti""LargeConfetti""ZigZag""Wave""DiagonalBrick""HorizontalBrick""Weave""Plaid""Divot""DottedGrid""DottedDiamond""Shingle""Trellis""Sphere""SmallGrid""SmallCheckerBoard""LargeCheckerBoard""OutlinedDiamond""SolidDiamond"
deadZoneOptions.strokeColorstringNo
deadZoneOptions.strokeStyleenumNo
"Solid""Dash""Dot""DashDot""DashDotDot""Custom"
deadZoneOptions.bottomnumberNo
deadZoneOptions.leftnumberNo
partOptionsobjectNo
partOptions.fillColorstringNo
partOptions.hatchStyleenum | nullNo
Show 53 values
"Horizontal""Vertical""ForwardDiagonal""BackwardDiagonal""Cross""DiagonalCross""Percent05""Percent10""Percent20""Percent25""Percent30""Percent40""Percent50""Percent60""Percent70""Percent75""Percent80""Percent90""LightDownwardDiagonal""LightUpwardDiagonal""DarkDownwardDiagonal""DarkUpwardDiagonal""WideDownwardDiagonal""WideUpwardDiagonal""LightVertical""LightHorizontal""NarrowVertical""NarrowHorizontal""DarkVertical""DarkHorizontal""DashedDownwardDiagonal""DashedUpwardDiagonal""DashedHorizontal""DashedVertical""SmallConfetti""LargeConfetti""ZigZag""Wave""DiagonalBrick""HorizontalBrick""Weave""Plaid""Divot""DottedGrid""DottedDiamond""Shingle""Trellis""Sphere""SmallGrid""SmallCheckerBoard""LargeCheckerBoard""OutlinedDiamond""SolidDiamond"
partOptions.strokeColorstringNo
partOptions.strokeStyleenumNo
"Solid""Dash""Dot""DashDot""DashDotDot""Custom"
remnantOptionsobjectNo
remnantOptions.fillColorstringNo
remnantOptions.hatchStyleenum | nullNo
Show 53 values
"Horizontal""Vertical""ForwardDiagonal""BackwardDiagonal""Cross""DiagonalCross""Percent05""Percent10""Percent20""Percent25""Percent30""Percent40""Percent50""Percent60""Percent70""Percent75""Percent80""Percent90""LightDownwardDiagonal""LightUpwardDiagonal""DarkDownwardDiagonal""DarkUpwardDiagonal""WideDownwardDiagonal""WideUpwardDiagonal""LightVertical""LightHorizontal""NarrowVertical""NarrowHorizontal""DarkVertical""DarkHorizontal""DashedDownwardDiagonal""DashedUpwardDiagonal""DashedHorizontal""DashedVertical""SmallConfetti""LargeConfetti""ZigZag""Wave""DiagonalBrick""HorizontalBrick""Weave""Plaid""Divot""DottedGrid""DottedDiamond""Shingle""Trellis""Sphere""SmallGrid""SmallCheckerBoard""LargeCheckerBoard""OutlinedDiamond""SolidDiamond"
remnantOptions.strokeColorstringNo
remnantOptions.strokeStyleenumNo
"Solid""Dash""Dot""DashDot""DashDotDot""Custom"

Status
When
200

Success

400

Bad Request

401

Unauthorized

500

An unexpected error occurred on the server.

Field
Type
Required
Description
dataobject | nullNo
data.parts[]object[]No

Collection of parts included in the nest

data.parts[].partIduuidNo

Unique identifier for the part

data.parts[].partNamestringNo

Name of the part

data.parts[].measurementUnitstringNo

Unit of measurement for the part's dimensions

data.parts[].scaleToMeasurementUnitbooleanNo

Whether the part geometry was scaled to match the measurement unit

data.parts[].grainbooleanNo

Whether grain direction was enforced during nesting

data.parts[].quantityintegerNo

Quantity of this part requested

data.sheets[]object[]No

Collection of sheets with their rendered layout images

data.sheets[].sheetobjectNo

Sheet layout details including dimensions and weight information

data.sheets[].sheet.sheetIduuidNo

Unique identifier for the sheet

data.sheets[].sheet.productIdstringNo

Product identifier for the sheet in the material catalog

data.sheets[].sheet.variantIdstringNo

Product variant identifier

data.sheets[].sheet.namestringNo

Display name of the sheet material

data.sheets[].sheet.materialTypestringNo

Material classification (e.g., "Steel", "Aluminum")

data.sheets[].sheet.weightCategorystringNo

Weight category classification of the material

data.sheets[].sheet.keepRemnantbooleanNo

Whether the remnant is retained after cutting

data.sheets[].sheet.remnantCropTypestringNo

How the remnant is cropped (e.g., "VerticalCrop", "HorizontalCrop")

data.sheets[].sheet.isCoilbooleanNo

Whether the source material is a coil

data.sheets[].sheet.lengthUnitstringNo

Unit of measure for all length values

data.sheets[].sheet.weightUnitstringNo

Unit of measure for all weight values

data.sheets[].sheet.lengthnumberNo

Total length of the sheet

data.sheets[].sheet.lengthUsednumberNo

Length of the sheet consumed by the nested parts

data.sheets[].sheet.widthnumberNo

Total width of the sheet

data.sheets[].sheet.widthUsednumberNo

Width of the sheet consumed by the nested parts

data.sheets[].sheet.thicknessnumberNo

Sheet thickness

data.sheets[].sheet.weightnumberNo

Total weight of the sheet

data.sheets[].sheet.unitPartWeightnumberNo

True weight of one piece of the nested part

data.sheets[].sheet.unitNestedWeightnumberNo

Nested weight of one piece (accounts for orientation and grain)

data.sheets[].sheet.unitRectangularWeightnumberNo

Bounding-box weight of one piece of the nested part

data.sheets[].sheet.totalPartWeightnumberNo

True weight of all nested parts combined

data.sheets[].sheet.totalRectangularWeightnumberNo

Bounding-box weight of all nested parts combined

data.sheets[].sheet.numberOfFullSheetsintegerNo

Number of complete full sheets used

data.sheets[].sheet.numberOfUnitsPerSheetintegerNo

Number of parts nested on a single sheet

data.sheets[].sheet.numberOfUnitsNestedintegerNo

Total number of part units successfully nested

data.sheets[].sheet.numberOfSheetsRequiredintegerNo

Total number of sheets required (rounded up)

data.sheets[].sheet.totalNumberOfSheetsnumberNo

Fractional total number of sheets consumed

data.sheets[].sheet.totalSheetWeightnumberNo

Total weight of all sheets consumed

data.sheets[].images[]string[]No

Base64-encoded PNG images of the nested layout on this sheet

data.sheets[].imageFormatstringNo

MIME type and encoding of the images (e.g., "image/png;base64")

data.cutLengthnumberNo

Total cut length across all nested parts

data.measurementUnitstringNo

Unit of measurement for the cut length

errors[]object[] | nullNo

One or more errors describing why the request failed. Absent (null) on success.

errors[].descriptionstring | nullNo

Human-readable explanation of the error. Intended for display to end users or logs. Wording is not stable and should not be branched on.

errors[].errorIdstring | nullNo

Machine-readable, stable error identifier. Consumers should branch on this value rather than on Description. See ConnectErrorIds for the catalog.

pagingobject | nullNo

Paging metadata for list endpoints. Absent on single-item responses.

paging.limitintegerNo
paging.startintegerNo
paging.totalintegerNo

Example 200 response
{
  "data": {
    "parts": [
      {
        "partId": "08fcc2e5-7760-493b-b8f1-1ad26fcb0a9e",
        "partName": "string",
        "measurementUnit": "string",
        "scaleToMeasurementUnit": true,
        "grain": true,
        "quantity": 0
      }
    ],
    "sheets": [
      {
        "sheet": {
          "sheetId": "1c65aa74-73fc-4fac-b8af-41acabfc39cc",
          "productId": "string",
          "variantId": "string",
          "name": "string",
          "materialType": "string",
          "weightCategory": "string",
          "keepRemnant": true,
          "remnantCropType": "string",
          "isCoil": true,
          "lengthUnit": "string",
          "weightUnit": "string",
          "length": 0.1,
          "lengthUsed": 0.1,
          "width": 0.1,
          "widthUsed": 0.1,
          "thickness": 0.1,
          "weight": 0.1,
          "unitPartWeight": 0.1,
          "unitNestedWeight": 0.1,
          "unitRectangularWeight": 0.1,
          "totalPartWeight": 0.1,
          "totalRectangularWeight": 0.1,
          "numberOfFullSheets": 0,
          "numberOfUnitsPerSheet": 0,
          "numberOfUnitsNested": 0,
          "numberOfSheetsRequired": 0,
          "totalNumberOfSheets": 0.1,
          "totalSheetWeight": 0.1
        },
        "images": [
          "string"
        ],
        "imageFormat": "string"
      }
    ],
    "cutLength": 0.1,
    "measurementUnit": "string"
  },
  "errors": [
    {
      "description": "string",
      "errorId": "string"
    }
  ],
  "paging": {
    "limit": 0,
    "start": 0,
    "total": 0
  }
}