Skip to content
Stella ConnectDocs
Nesting

Create a single-part linear nest

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

Nests a single part onto linear stock. Returns per-bar cut-list and yield results. To nest multiple distinct part types in one call, use LinearNestMultipleParts.

Authx-api-key

application/json
Field
Type
Required
outputLengthUnitstringNo
outputWeightUnitstringNo
stockobjectYes
stock.namestringNo
stock.weightPerLengthnumberYes
stock.weightPerLengthUnitstringNo
stock.lengthnumberYes
stock.lengthUnitstringNo
stock.quantityinteger | nullNo
optionsobject | nullNo
options.chucknumberNo
options.chuckUnitstringNo
options.kerfnumberNo
options.kerfUnitstringNo
options.remnantPolicyobjectNo
options.remnantPolicy.keepRemnantbooleanNo
options.remnantPolicy.minimumLengthnumber | nullNo
options.remnantPolicy.lengthUnitstringNo
partobjectYes
part.lengthnumberYes
part.lengthUnitstringYes
part.quantityintegerYes

Status
When
200

Success

400

Bad Request

401

Unauthorized

500

An unexpected error occurred on the server.

Field
Type
Required
Description
dataobject | nullNo
data.nestingIduuidNo

Unique identifier for the nesting result

data.partobjectNo

Nesting result for the single part

data.part.partIduuidNo

Unique identifier for the part

data.part.quantityintegerNo

Requested quantity for this part

data.part.lengthnumberNo

Required cut length per piece

data.part.lengthUnitstringNo

Unit of measure for the length (e.g., "Inch", "Millimeter")

data.part.totalItemsNestedintegerNo

Total number of pieces successfully nested

data.part.totalNestedLengthnumberNo

Total cut length for all nested pieces

data.part.totalNestedWeightnumberNo

Total weight of the nested material used

data.part.totalTrueWeightnumberNo

Total true (actual part geometry) weight of all nested pieces

data.stock[]object[]No

Collection of stock layouts used to fulfill the part quantity

data.stock[].stockIduuidNo

Unique identifier for the stock item

data.stock[].numberOfPartsPerUnitintegerNo

Number of parts cut from a single stock unit

data.stock[].keepRemnantbooleanNo

Whether remnants are retained after cutting

data.stock[].numberOfUnitsintegerNo

Total number of stock units required

data.stock[].totalStockLengthnumberNo

Total length of all stock units combined

data.stock[].totalStockLengthUsednumberNo

Total length consumed across all stock units

data.stock[].totalStockWeightnumberNo

Total weight of all stock units combined

data.stock[].totalStockWeightUsednumberNo

Total weight of material consumed across all stock units

data.stock[].unitStockLengthnumberNo

Length of a single stock unit

data.stock[].unitStockLengthUsednumberNo

Length consumed from a single stock unit

data.stock[].unitStockWeightnumberNo

Weight of a single stock unit

data.stock[].unitStockWeightUsednumberNo

Weight of material consumed from a single stock unit

data.stock[].lengthUnitstringNo

Unit of measure for all length values

data.stock[].weightUnitstringNo

Unit of measure for all weight values

data.stock[].partobjectNo

The part nested on this stock layout

data.stock[].part.partIduuidNo

Unique identifier for the part

data.stock[].part.quantityintegerNo

Number of pieces of this part cut from the stock unit

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": {
    "nestingId": "11e99bc8-e511-474a-b049-938734f567db",
    "part": {
      "partId": "08fcc2e5-7760-493b-b8f1-1ad26fcb0a9e",
      "quantity": 0,
      "length": 0.1,
      "lengthUnit": "string",
      "totalItemsNested": 0,
      "totalNestedLength": 0.1,
      "totalNestedWeight": 0.1,
      "totalTrueWeight": 0.1
    },
    "stock": [
      {
        "stockId": "a43dc3b0-820c-4762-b37b-45e91f17720c",
        "numberOfPartsPerUnit": 0,
        "keepRemnant": true,
        "numberOfUnits": 0,
        "totalStockLength": 0.1,
        "totalStockLengthUsed": 0.1,
        "totalStockWeight": 0.1,
        "totalStockWeightUsed": 0.1,
        "unitStockLength": 0.1,
        "unitStockLengthUsed": 0.1,
        "unitStockWeight": 0.1,
        "unitStockWeightUsed": 0.1,
        "lengthUnit": "string",
        "weightUnit": "string",
        "part": {
          "partId": "08fcc2e5-7760-493b-b8f1-1ad26fcb0a9e",
          "quantity": 0
        }
      }
    ]
  },
  "errors": [
    {
      "description": "string",
      "errorId": "string"
    }
  ],
  "paging": {
    "limit": 0,
    "start": 0,
    "total": 0
  }
}