Skip to content
Stella ConnectDocs
Nesting

Create a single-part nest

POST{baseUrl}/v1.0/nesting/planar/singlepart

This endpoint creates a planar nest for a single part on a specified sheet. Need to turn a file into parts? Check out Import Parts

Note: If you need to nest multiple parts, please use the multi-part nesting endpoint.

Authx-api-key

application/json
Field
Type
Required
Description
outputLengthUnitstringNo

The unit of measurement for output lengths.

outputWeightUnitstringNo

The unit of measurement for output weights.

optionsobjectYes
options.clearanceobjectNo
options.clearance.edgenumberNo
options.clearance.edgeUnitstringNo
options.clearance.partnumberNo
options.clearance.partUnitstringNo
options.croppingobjectNo
options.cropping.horizontalnumberNo
options.cropping.horizontalUnitstringNo
options.cropping.verticalnumberNo
options.cropping.verticalUnitstringNo
options.deadZoneobjectNo
options.deadZone.bottomnumberNo
options.deadZone.bottomUnitstringNo
options.deadZone.leftnumberNo
options.deadZone.leftUnitstringNo
options.remnantobjectNo
options.remnant.keepRemnantbooleanNo
options.remnant.minimumLengthnumber | nullNo
options.remnant.lengthUnitstring | nullNo
options.remnant.minimumWidthnumber | nullNo
options.remnant.widthUnitstring | nullNo
sheetobjectYes
sheet.namestringNo
sheet.productIdstringNo
sheet.variantIdstring | nullNo
sheet.materialTypestringNo
sheet.densitynumberNo
sheet.densityUnitstringNo
sheet.thicknessnumberNo
sheet.thicknessUnitstringNo
sheet.lengthnumberNo
sheet.lengthUnitstringNo
sheet.widthnumberNo
sheet.widthUnitstringNo
sheet.quantityintegerNo
partobjectYes
part.partIduuidYes
part.partNamestringNo
part.measurementUnitstring | nullNo

Override for the part's measurement unit. Leave null to use the unit stored on the part.

part.grainbooleanNo
part.quantityintegerNo

Status
When
200

Success

400

Bad Request

401

Unauthorized

500

Server Error

Field
Type
Required
Description
nestingIduuidNo

The unique identifier for the nesting operation.

sheetobjectNo

The collection of Sheet information used in the nesting operation.

sheet.sheetIduuidNo

Unique identifier for the sheet/plate

sheet.namestringNo

Display name of the sheet material

sheet.productIdstringNo

Product identifier for the sheet in the material catalog

sheet.densitynumberNo

Material density

sheet.densityUnitstringNo

Unit of measure for density

sheet.thicknessnumberNo

Sheet thickness

sheet.thicknessUnitstringNo

Unit of measure for thickness

sheet.materialTypestringNo

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

sheet.lengthnumberNo

Sheet length

sheet.lengthUnitstringNo

Unit of measure for length

sheet.widthnumberNo

Sheet width

sheet.widthUnitstringNo

Unit of measure for width

sheet.weightUnitstringNo

Unit of measure for weight values

sheet.totalWeightnumberNo

Total weight of all plates.

sheet.totalWeightUsednumberNo

Total used weight of all plates.

sheet.numberOfSheetsRequiredintegerNo

Total number of sheets required to nest parts.

sheet.numberOfSheetsPercentagenumberNo

Average utilization percentage across all sheets

sheet.sheetUsage[]object[]No

Breakdown of how sheets are used across the nesting groups

sheet.sheetUsage[].keepRemnantbooleanNo

Whether remnant material is retained after this nesting group

sheet.sheetUsage[].remnantCropTypestringNo

How the remnant is cropped (e.g., "full-width", "partial")

sheet.sheetUsage[].weightUsednumberNo

Total material weight consumed in this nesting group

sheet.sheetUsage[].numberOfSheetsintegerNo

Number of sheets in this nesting group

sheet.sheetUsage[].partsUsed[]object[]No

Parts nested on the sheets in this nesting group

sheet.sheetUsage[].partsUsed[].partIduuidNo

Unique identifier for the part

sheet.sheetUsage[].partsUsed[].numberOfPartsNestedintegerNo

Total number of parts nested on all sheets in group.

sheet.sheetUsage[].partsUsed[].unitNestedWeightnumberNo

Weight of one nested piece of this part

partobjectNo

The part response included in the nesting operation.

part.partIduuidNo

The unique identifier for the part.

part.namestringNo

The given name of the part.

part.unitRectangularWeightnumberNo

The unit rectangular weight of the part.

part.unitTrueWeightnumberNo

The true weight of the part.

Example 200 response
{
  "nestingId": "11e99bc8-e511-474a-b049-938734f567db",
  "sheet": {
    "sheetId": "1c65aa74-73fc-4fac-b8af-41acabfc39cc",
    "name": "string",
    "productId": "string",
    "density": 0.1,
    "densityUnit": "string",
    "thickness": 0.1,
    "thicknessUnit": "string",
    "materialType": "string",
    "length": 0.1,
    "lengthUnit": "string",
    "width": 0.1,
    "widthUnit": "string",
    "weightUnit": "string",
    "totalWeight": 0.1,
    "totalWeightUsed": 0.1,
    "numberOfSheetsRequired": 0,
    "numberOfSheetsPercentage": 0.1,
    "sheetUsage": [
      {
        "keepRemnant": true,
        "remnantCropType": "string",
        "weightUsed": 0.1,
        "numberOfSheets": 0,
        "partsUsed": [
          {
            "partId": "08fcc2e5-7760-493b-b8f1-1ad26fcb0a9e",
            "numberOfPartsNested": 0,
            "unitNestedWeight": 0.1
          }
        ]
      }
    ]
  },
  "part": {
    "partId": "08fcc2e5-7760-493b-b8f1-1ad26fcb0a9e",
    "name": "string",
    "unitRectangularWeight": 0.1,
    "unitTrueWeight": 0.1
  }
}