PackNet DIM Carton Create Endpoint
Creates cartons based on the provided carton request. It identifies and retrieves item-level dimensional data, calculates optimal carton configurations through cubing logic, and passes finalized carton data to PackNet Core for production.
Important
PackNet DIM Carton Create API endpoints require a Professional or Enterprise license tier. Users with lower-tier licenses will receive a 403 Forbidden response.
[POST] https://api.prod1.packnet.app/Dim/v1/Carton/Create/
Status Codes
200 OK: Command received and processed.
400 Bad request: The request cannot be processed due to apparent client error.
403 Forbidden: The user is not allowed to make the request.
500 Internal server error: The server does not know how to process the request.
{
"orderId": "ORDER-12345",
"brand": "1",
"cartonDesign": "",
"productionGroup": "",
"machineGroup": "",
"x-value": "1",
"aCustomValue": "Brown",
"itemsToPack": [
{
"productId": "514",
"quantity": 2,
"dimensions": {
"length": 12,
"width": 10,
"height": 8
},
"description": "Keep all your bread in this kitchen basket",
"name": "Bread Basket",
"orientationLocked": true,
"weight": 0.58,
"CanContain": true,
"voidFill": {
"length": 11,
"width": 9,
"height": 7
},
"canNest": true,
"nesting": {
"nestGrowthDimension1": 0,
"nestGrowthDimension2": 0,
"nestGrowthDimension3": 1,
"nestMax": 10
},
"RequiresPadding": false,
"useDefaultPadding": false,
"padding": 2,
"isSingleLayer": true
}
]
}{
"success": true,
"message": "Operation completed successfully"
}PackNet DIM Carton Create Field Descriptions
Carton Create Request Parameters
Main Request Object
Field | Data Type | Required | Description |
|---|---|---|---|
orderId | String | Yes | Unique identifier for the order |
brand | String | No | Brand name for the carton |
cartonDesign | String | No | Carton design specification |
productionGroup | String | No | Production group identifier |
machineGroup | String | No | Machine group identifier |
xValues | Object | No | Dictionary of custom X values (key-value pairs) |
aCustomValue | String | No | Custom attribute applied to the order, often used for color or material |
itemsToPack | ItemToPack | Yes | List of items to pack in the carton |
itemsToPack Objects
Field | Data Type | Required | Description |
|---|---|---|---|
productId | String | Yes | Product identifier (must exist in the system or dimensions must be provided) |
quantity | Integer | Yes | Number of items (must be greater than 0) |
dimensions | Object | No | Product dimensions (required when product doesn't exist in the system) |
description | String | No | Detailed description of the product |
name | String | Yes | Product name or label |
orientationLocked | Boolean | No | Indicates if product orientation must remain fixed during packing |
weight | Float | No | Product weight in kilograms or pounds (depending on system) |
canContain | Boolean | No | Specifies if the product can contain other items inside it |
voidFill | Object | No | Defines void-fill space dimensions around the product |
canNest | Boolean | No | Indicates whether the product can be nested inside another of the same type to save space; the nesting behavior is defined in the nesting object |
nesting | Object | No | Specifies nesting behavior if product can stack inside another |
requiresPadding | Boolean | No | Whether the product requires padding during packaging |
useDefaultPadding | Boolean | No | If true, applies default padding values from system configuration |
padding | Integer | No | Manual padding amount (in chosen unit) |
isSingleLayer | Boolean | No | Determines if the product must be packed in a single layer |
dimensions Object
Field | Data Type | Required | Description |
|---|---|---|---|
length | Float | Yes | Length of the product |
width | Float | Yes | Width of the product |
height | Float | Yes | Height of the product |
voidFill Object
Field | Data Type | Required | Description |
|---|---|---|---|
length | Integer | No | Void-fill length dimension |
width | Integer | No | Void-fill width dimension |
height | Integer | No | Void-fill height dimension |
nesting Object
Field | Data Type | Required | Description |
|---|---|---|---|
nestGrowthDimension1 | Integer | No | Growth factor for first nesting dimension |
nestGrowthDimension2 | Integer | No | Growth factor for second nesting dimension |
nestGrowthDimension3 | Integer | No | Growth factor for third nesting dimension |
nestMax | Integer | No | Maximum number of items that can be nested |
Note
When product attributes, including dimensions, are provided in an API request, those values are used for carton creation regardless of if the product is stored in the DIM database. When dimensions are not provided, the system will look up the product in the DIM database and use the stored dimensions.