Create a nest
Creates a Nest from a set of parts. Need to turn a file into parts? Check out Import Part.
x-api-keyapplication/jsonField | Type | Required | Description |
|---|---|---|---|
| outputLengthUnit | string | No | The unit of measurement for output lengths. |
| outputTimeUnit | string | No | The unit of measurement for output times. |
| outputWeightUnit | string | No | The unit of measurement for output weights. |
| nestingOptions | object | Yes | |
| nestingOptions. | boolean | No | |
| nestingOptions. | number | No | |
| nestingOptions. | number | No | |
| nestingOptions. | number | No | |
| nestingOptions. | number | No | |
| nestingOptions. | number | No | |
| nestingOptions. | number | No | |
| nestingOptions. | number | No | |
| nestingOptions. | number | No | |
| nestingOptions. | string | No | |
| nestingOptions. | number | No | |
| parts[] | object[] | Yes | |
| parts[]. | uuid | No | |
| parts[]. | string | No | |
| parts[]. | string | No | |
| parts[]. | boolean | No | |
| parts[]. | boolean | No | |
| parts[]. | integer | No | |
| sheetOptions | object | Yes | |
| sheetOptions. | string | No | |
| sheetOptions. | string | No | |
| sheetOptions. | string | No | |
| sheetOptions. | number | No | |
| sheetOptions. | string | No | |
| sheetOptions. | number | No | |
| sheetOptions. | string | No | |
| sheetOptions. | object[] | No | |
| sheetOptions. | string | No | |
| sheetOptions. | string | No | |
| sheetOptions. | number | No | |
| sheetOptions. | number | No | |
| sheetOptions. | integer | No | |
| measurementUnit | string | No | |
| imageHeight | integer | Yes | |
| imageWidth | integer | Yes | |
| croppingOptions | object | No | |
| croppingOptions. | string | No | |
| croppingOptions. | enum | null | No | 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. | string | No | |
| croppingOptions. | enum | No | "Solid""Dash""Dot""DashDot""DashDotDot""Custom" |
| croppingOptions. | number | No | |
| croppingOptions. | number | No | |
| deadZoneOptions | object | No | |
| deadZoneOptions. | string | No | |
| deadZoneOptions. | enum | null | No | 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. | string | No | |
| deadZoneOptions. | enum | No | "Solid""Dash""Dot""DashDot""DashDotDot""Custom" |
| deadZoneOptions. | number | No | |
| deadZoneOptions. | number | No | |
| partOptions | object | No | |
| partOptions. | string | No | |
| partOptions. | enum | null | No | 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. | string | No | |
| partOptions. | enum | No | "Solid""Dash""Dot""DashDot""DashDotDot""Custom" |
| remnantOptions | object | No | |
| remnantOptions. | string | No | |
| remnantOptions. | enum | null | No | 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. | string | No | |
| remnantOptions. | enum | No | "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 |
|---|---|---|---|
| data | object | null | No | |
| data. | object[] | No | Collection of parts included in the nest |
| data. | uuid | No | Unique identifier for the part |
| data. | string | No | Name of the part |
| data. | string | No | Unit of measurement for the part's dimensions |
| data. | boolean | No | Whether the part geometry was scaled to match the measurement unit |
| data. | boolean | No | Whether grain direction was enforced during nesting |
| data. | integer | No | Quantity of this part requested |
| data. | object[] | No | Collection of sheets with their rendered layout images |
| data. | object | No | Sheet layout details including dimensions and weight information |
| data. | uuid | No | Unique identifier for the sheet |
| data. | string | No | Product identifier for the sheet in the material catalog |
| data. | string | No | Product variant identifier |
| data. | string | No | Display name of the sheet material |
| data. | string | No | Material classification (e.g., "Steel", "Aluminum") |
| data. | string | No | Weight category classification of the material |
| data. | boolean | No | Whether the remnant is retained after cutting |
| data. | string | No | How the remnant is cropped (e.g., "VerticalCrop", "HorizontalCrop") |
| data. | boolean | No | Whether the source material is a coil |
| data. | string | No | Unit of measure for all length values |
| data. | string | No | Unit of measure for all weight values |
| data. | number | No | Total length of the sheet |
| data. | number | No | Length of the sheet consumed by the nested parts |
| data. | number | No | Total width of the sheet |
| data. | number | No | Width of the sheet consumed by the nested parts |
| data. | number | No | Sheet thickness |
| data. | number | No | Total weight of the sheet |
| data. | number | No | True weight of one piece of the nested part |
| data. | number | No | Nested weight of one piece (accounts for orientation and grain) |
| data. | number | No | Bounding-box weight of one piece of the nested part |
| data. | number | No | True weight of all nested parts combined |
| data. | number | No | Bounding-box weight of all nested parts combined |
| data. | integer | No | Number of complete full sheets used |
| data. | integer | No | Number of parts nested on a single sheet |
| data. | integer | No | Total number of part units successfully nested |
| data. | integer | No | Total number of sheets required (rounded up) |
| data. | number | No | Fractional total number of sheets consumed |
| data. | number | No | Total weight of all sheets consumed |
| data. | string[] | No | Base64-encoded PNG images of the nested layout on this sheet |
| data. | string | No | MIME type and encoding of the images (e.g., "image/png;base64") |
| data. | number | No | Total cut length across all nested parts |
| data. | string | No | Unit of measurement for the cut length |
| errors[] | object[] | null | No | One or more errors describing why the request failed. Absent ( |
| errors[]. | string | null | No | 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[]. | string | null | No | Machine-readable, stable error identifier. Consumers should branch on this value
rather than on Description. See |
| paging | object | null | No | Paging metadata for list endpoints. Absent on single-item responses. |
| paging. | integer | No | |
| paging. | integer | No | |
| paging. | integer | No |
{
"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
}
}