FractalPack Packing API (1.0.0)

Download OpenAPI specification:

FractalPack Engineering: support@fractalpack.com URL: https://fractalpack.com License: Proprietary

The FractalPack Packing API provides 3D bin-packing, order management, shipment optimization, consolidation, wave planning, and fulfillment planning capabilities.

All endpoints are served under https://api.fractalpack.com and require authentication via either an API key or a JWT bearer token.

Pagination

List endpoints use cursor-based pagination. Pass limit (page size) and cursor (opaque token from a previous response's nextCursor). The response includes an items array and a nextCursor field (null when there are no more results).

Rate Limiting

Certain endpoint categories are rate-limited: pack, batch, ai, and rates. Every rate-limited response includes these headers:

Header	Description
`X-RateLimit-Limit`	Max requests in the current window
`X-RateLimit-Remaining`	Requests remaining
`X-RateLimit-Reset`	Seconds until the window resets
`Retry-After`	Seconds to wait (only on 429)

Errors

All errors use RFC 9457 Problem Details format with a doc_url extension linking to the relevant error documentation.

Packing

Core 3D bin-packing engine

Pack items into containers

Run the 3D bin-packing algorithm to optimally place items into containers, pallets, and/or equipment. If no containers are specified, the system falls back to the organization's Container Master.

Rules are automatically evaluated and applied before packing.

Rate limit category: pack

Authorizations:

ApiKeyAuthBearerAuth

Request Body schema: application/json
required

required	Array of objects (ItemDto) [ 1 .. 10000 ] items Items to pack
	Array of objects (ContainerDto) <= 1000 items Fixed-size containers. If omitted, falls back to Container Master.
	Array of objects (DynamicContainerDto) <= 1000 items Variable-size containers
	Array of objects (PalletDto) <= 100 items Pallet definitions
	Array of objects (EquipmentDto) <= 100 items Equipment (trailers, etc.)
allowMultipleBoxes	boolean Default: false Allow items to be packed into multiple boxes
loadingMode	string Default: "palletized" Loading mode: "standard", "palletized"
algorithm	string Enum: "ebAfit" "liquidFill" "fpFast" Packing algorithm: "ebAfit", "liquidFill", "fpFast"
useCasePacks	boolean Default: false Use case pack configurations from items
allowPalletStacking	boolean Default: false Allow stacking pallets in trailers
respectTiHi	boolean Default: true Use vendor-prescribed Ti/Hi pallet patterns
separationGroups	Array of strings[ items ] Groups of item tags that cannot share a container. Items from different groups are packed separately.
	Array of objects (AffinityGroupDto) Pin specific items to specific containers
optimizeFor	string Enum: "volume" "cost" Optimization objective (default "volume")
originZip	string <= 10 characters Origin ZIP code (required for cost optimization)
destinationZip	string <= 10 characters Destination ZIP code (required for cost optimization)

Responses

Request samples

Payload

Content type

application/json

{"items": [{"id": "WIDGET-001",
"length": 10,
"width": 8,
"height": 6,
"weight": 2.5,
"quantity": 3
},
{"id": "GADGET-002",
"length": 12,
"width": 10,
"height": 4,
"weight": 1.8,
"quantity": 2
}
],
"containers": [{"id": "BOX-MEDIUM",
"length": 20,
"width": 15,
"height": 12,
"maxWeight": 50
}
],
"allowMultipleBoxes": true,
"algorithm": "ebAfit"
}

Response samples

200
400
401
403
429

Content type

application/json

{"algorithm": "ebAfit",
"results": [{"containerId": "BOX-MEDIUM",
"boxIndex": 0,
"containerDimensions": {"length": 20,
"width": 15,
"height": 12
},
"packedItems": [{"id": "WIDGET-001",
"coordinate": {"x": 0,
"y": 0,
"z": 0
},
"packedDimensions": {"length": 10,
"width": 8,
"height": 6
},
"weight": 2.5,
"tags": [ ]
}
],
"unpackedItems": [ ],
"volumeUtilizationPercent": 68.5,
"totalWeight": 12.1
}
],
"firedRules": [ ]
}

Batch

Asynchronous batch packing

Submit a batch of packing jobs

Submit up to 10,000 orders for asynchronous packing. Returns immediately with a batch ID and status URL.

Optionally provide a webhookUrl (HTTPS only) to receive a callback when the batch completes.

Rate limit category: batch

Authorizations:

ApiKeyAuthBearerAuth

Request Body schema: application/json
required

required	Array of objects (BatchOrderRequest) [ 1 .. 10000 ] items
webhookUrl	string <uri> <= 2048 characters HTTPS URL to receive completion callback

Responses

Request samples

Payload

Content type

application/json

{"orders": [{"orderId": "ORD-001",
"packRequest": {"items": [{"id": "SKU-A",
"length": 10,
"width": 8,
"height": 6,
"weight": 2,
"quantity": 1
}
],
"containers": [{"id": "SM-BOX",
"length": 12,
"width": 10,
"height": 8,
"maxWeight": 25
}
]
}
}
],
"webhookUrl": "https://example.com/webhook/batch-complete"
}

Response samples

202
400
401
429

Content type

application/json

{"batchId": "bat_abc123",
"status": "submitted",
"totalOrders": 1,
"statusUrl": "/api/v1/batch/bat_abc123"
}

List batches

Authorizations:

ApiKeyAuthBearerAuth

query Parameters

limit	integer [ 1 .. 100 ] Default: 20 Maximum number of items to return
after	string Pagination cursor from `nextPageToken`

Responses

Response samples

200
401

Content type

application/json

{"batches": [{"batchId": "string",
"status": "string",
"totalOrders": 0,
"completedOrders": 0,
"failedOrders": 0,
"createdAt": "2019-08-24T14:15:22Z",
"completedAt": "2019-08-24T14:15:22Z"
}
],
"nextPageToken": "string",
"hasMore": true
}

Get batch status and results

Authorizations:

ApiKeyAuthBearerAuth

path Parameters

batchId

required

string

query Parameters

status	string Enum: "pending" "completed" "failed" Filter orders by status
limit	integer [ 1 .. 1000 ] Default: 100
after	string Pagination cursor

Responses

Response samples

200
401
404

Content type

application/json

{"batchId": "string",
"status": "submitted",
"totalOrders": 0,
"completedOrders": 0,
"failedOrders": 0,
"pendingOrders": 0,
"createdAt": "2019-08-24T14:15:22Z",
"completedAt": "2019-08-24T14:15:22Z",
"orders": [{"orderId": "string",
"status": "pending",
"result": {"algorithm": "string",
"results": [{"containerId": "string",
"boxIndex": 0,
"containerDimensions": {"length": 0.1,
"width": 0.1,
"height": 0.1
},
"packedItems": [{"id": "string",
"coordinate": {"x": 0.1,
"y": 0.1,
"z": 0.1
},
"packedDimensions": {"length": 0.1,
"width": 0.1,
"height": 0.1
},
"weight": 0.1,
"tags": ["string"
],
"nestedItems": [{ }
],
"rollInfo": {"sourceItemId": "string",
"rollIndex": 0,
"totalRolls": 0,
"linearQuantityOnRoll": 0.1,
"outerDiameter": 0.1
},
"sourceOrderId": "string",
"sourceLineNumber": 0
}
],
"unpackedItems": [{"id": "string",
"dimensions": {"length": 0.1,
"width": 0.1,
"height": 0.1
},
"weight": 0.1,
"rollInfo": {"sourceItemId": "string",
"rollIndex": 0,
"totalRolls": 0,
"linearQuantityOnRoll": 0.1,
"outerDiameter": 0.1
},
"sourceOrderId": "string",
"sourceLineNumber": 0
}
],
"volumeUtilizationPercent": 0.1,
"totalWeight": 0.1,
"sourceOrderIds": ["string"
],
"costBreakdown": {"shippingCost": 0,
"boxCost": 0,
"totalCost": 0,
"billableWeight": 0.1,
"dimWeight": 0.1,
"actualWeight": 0.1,
"carrier": "string",
"service": "string",
"zone": 0
}
}
],
"palletResults": {"pallets": [{"palletId": "string",
"palletIndex": 0,
"palletDimensions": {"length": 0.1,
"width": 0.1,
"height": 0.1
},
"cartons": [{"cartonId": "string",
"coordinate": {"x": null,
"y": null,
"z": null
},
"packedDimensions": {"length": null,
"width": null,
"height": null
},
"weight": 0.1
}
],
"volumeUtilizationPercent": 0.1,
"totalWeight": 0.1,
"palletWeight": 0.1,
"platformHeight": 0.1
}
],
"unpalletizedCartons": [{"cartonId": "string",
"dimensions": {"length": 0.1,
"width": 0.1,
"height": 0.1
},
"weight": 0.1
}
]
},
"trailerResults": {"trailers": [{"trailerId": "string",
"trailerIndex": 0,
"equipmentType": "string",
"trailerDimensions": {"length": 0.1,
"width": 0.1,
"height": 0.1
},
"pallets": [{"palletId": "string",
"coordinate": {"x": null,
"y": null,
"z": null
},
"palletDimensions": {"length": null,
"width": null,
"height": null
},
"weight": 0.1,
"stackInfo": {"bottomPalletId": null,
"topPalletId": null,
"bottomHeight": null,
"topHeight": null
}
}
],
"floorLoadedCartons": [{"cartonId": "string",
"coordinate": {"x": null,
"y": null,
"z": null
},
"packedDimensions": {"length": null,
"width": null,
"height": null
},
"weight": 0.1
}
],
"volumeUtilizationPercent": 0.1,
"totalWeight": 0.1,
"tareWeight": 0.1
}
],
"unloadedPallets": [{"palletId": "string",
"dimensions": {"length": 0.1,
"width": 0.1,
"height": 0.1
},
"weight": 0.1
}
],
"unloadedCartons": [{"cartonId": "string",
"dimensions": {"length": 0.1,
"width": 0.1,
"height": 0.1
},
"weight": 0.1
}
]
},
"firedRules": [{"ruleId": "string",
"ruleName": "string",
"ruleType": "string",
"summary": "string"
}
]
},
"error": "string"
}
],
"nextPageToken": "string",
"hasMore": true
}

Items

Item Master CRUD and bulk operations

Create an item

Authorizations:

ApiKeyAuthBearerAuth

Request Body schema: application/json
required

id required	string [ 1 .. 128 ] characters
name	string <= 256 characters
description	string <= 2000 characters
	object
category	string <= 64 characters
commodityCode	string <= 64 characters
hsCode	string <= 64 characters
countryOfOrigin	string <= 64 characters
tags	Array of strings
	object
length required	number <double> Length in inches
width required	number <double>
height required	number <double>
dimensionUnit	string <= 64 characters
weight required	number <double> Weight in lbs
netWeight	number <double>
weightUnit	string <= 64 characters
volume	number <double>
volumeUnit	string <= 64 characters
unitOfMeasure	string <= 64 characters
	object (RollPropertiesDto)
	object (VoidSpaceDto)
shape	string Enum: "rectangular" "cylindrical" "spherical" "irregular" "lShape" "tShape" "custom"
	object
maxWeightOnTop	number <double>
maxStackHeight	integer
crushClass	string Enum: "none" "light" "moderate" "fragile" "extreme"
shipAlone	boolean
maxPerContainer	integer
	Array of objects
casePackQuantity	integer
caseLength	number <double>
caseWidth	number <double>
caseHeight	number <double>
caseWeight	number <double>
	object
freightClass	string <= 64 characters
imageUrl	string <uri> <= 2048 characters

Responses

Request samples

Payload

Content type

application/json

{"id": "WIDGET-001",
"name": "Blue Widget",
"length": 10,
"width": 8,
"height": 6,
"weight": 2.5,
"category": "electronics",
"tags": ["fragile"
]
}

Response samples

201
400
401
409

Content type

application/json

{"id": "string",
"name": "string",
"description": "string",
"externalIds": {"property1": "string",
"property2": "string"
},
"category": "string",
"tags": ["string"
],
"length": 0.1,
"width": 0.1,
"height": 0.1,
"weight": 0.1,
"unitOfMeasure": "string",
"shape": "string",
"shipAlone": true,
"packagingLevels": [{ }
],
"version": 0,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"createdBy": "string"
}

List items

Authorizations:

ApiKeyAuthBearerAuth

query Parameters

limit	integer [ 1 .. 100 ] Default: 20 Maximum number of items to return
cursor	string Opaque pagination cursor from a previous response's `nextCursor`
search	string Full-text search across ID, name, and description
category	string Filter by category
tags	string Comma-separated list of tags to filter by

Responses

Response samples

200
401

Content type

application/json

{"items": [{"id": "string",
"name": "string",
"description": "string",
"externalIds": {"property1": "string",
"property2": "string"
},
"category": "string",
"tags": ["string"
],
"length": 0.1,
"width": 0.1,
"height": 0.1,
"weight": 0.1,
"unitOfMeasure": "string",
"shape": "string",
"shipAlone": true,
"packagingLevels": [{ }
],
"version": 0,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"createdBy": "string"
}
],
"nextCursor": "string"
}

Get an item by ID

Authorizations:

ApiKeyAuthBearerAuth

path Parameters

itemId

required

string

Responses

Response samples

200
401
404

Content type

application/json

{"id": "string",
"name": "string",
"description": "string",
"externalIds": {"property1": "string",
"property2": "string"
},
"category": "string",
"tags": ["string"
],
"length": 0.1,
"width": 0.1,
"height": 0.1,
"weight": 0.1,
"unitOfMeasure": "string",
"shape": "string",
"shipAlone": true,
"packagingLevels": [{ }
],
"version": 0,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"createdBy": "string"
}

Partially update an item

Update one or more fields on an item. Requires the current version for optimistic concurrency control.

Authorizations:

ApiKeyAuthBearerAuth

path Parameters

itemId

required

string

Request Body schema: application/json
required

version required	integer >= 1 Current version for optimistic concurrency
name	string <= 256 characters
description	string <= 2000 characters
category	string <= 64 characters
tags	Array of strings
length	number <double>
width	number <double>
height	number <double>
weight	number <double>
shipAlone	boolean
packagingLevels	Array of objects

Responses

Request samples

Payload

Content type

application/json

{"version": 1,
"weight": 3,
"tags": ["fragile",
"electronic"
]
}

Response samples

200
401
404
409

Content type

application/json

{"id": "string",
"name": "string",
"description": "string",
"externalIds": {"property1": "string",
"property2": "string"
},
"category": "string",
"tags": ["string"
],
"length": 0.1,
"width": 0.1,
"height": 0.1,
"weight": 0.1,
"unitOfMeasure": "string",
"shape": "string",
"shipAlone": true,
"packagingLevels": [{ }
],
"version": 0,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"createdBy": "string"
}

Delete an item

Requires admin role.

Authorizations:

ApiKeyAuthBearerAuth

path Parameters

itemId

required

string

Responses

Response samples

401
403
404

Content type

application/problem+json

{"type": "https://developers.fractalpack.com/errors/unauthorized",
"title": "Unauthorized",
"status": 401,
"detail": "Invalid or missing authentication credentials.",
"instance": "0HN9A1B2C3D4:00000002",
"doc_url": "https://developers.fractalpack.com/errors/unauthorized"
}

Bulk import items

Import up to 1,000 items at once. Existing items (by ID) are updated; new items are created. Requires admin role.

Authorizations:

ApiKeyAuthBearerAuth

Request Body schema: application/json
required

required

Array of objects (CreateItemRequest) [ 1 .. 1000 ] items

Responses

Request samples

Payload

Content type

application/json

{"items": [{"id": "string",
"name": "string",
"description": "string",
"externalIds": {"gtin": "string",
"upc": "string",
"ean": "string",
"vendorPartNumber": "string",
"customerPartNumber": "string",
"property1": "string",
"property2": "string"
},
"category": "string",
"commodityCode": "string",
"hsCode": "string",
"countryOfOrigin": "string",
"tags": ["string"
],
"customAttributes": { },
"length": 0.1,
"width": 0.1,
"height": 0.1,
"dimensionUnit": "string",
"weight": 0.1,
"netWeight": 0.1,
"weightUnit": "string",
"volume": 0.1,
"volumeUnit": "string",
"unitOfMeasure": "string",
"rollProperties": {"materialThickness": 0.1,
"materialWidth": 0.1,
"coreInnerDiameter": 0.1,
"coreWallThickness": 0.1,
"maxRollOuterDiameter": 0.1,
"maxLinearQuantityPerRoll": 0.1,
"weightPerUnitLength": 0.1
},
"voidSpace": {"shape": "rectangular",
"length": 0.1,
"width": 0.1,
"height": 0.1
},
"shape": "rectangular",
"orientationConstraints": {"allowedRotations": ["string"
],
"keepUpright": true,
"arrowsUp": true,
"floorContactFaces": ["string"
]
},
"maxWeightOnTop": 0.1,
"maxStackHeight": 0,
"crushClass": "none",
"shipAlone": true,
"maxPerContainer": 0,
"packagingLevels": [{"level": "string",
"quantity": 0,
"length": 0.1,
"width": 0.1,
"height": 0.1,
"weight": 0.1,
"tiHiTi": 0,
"tiHiHi": 0
}
],
"casePackQuantity": 0,
"caseLength": 0.1,
"caseWidth": 0.1,
"caseHeight": 0.1,
"caseWeight": 0.1,
"hazmat": {"unNumber": "string",
"hazardClass": "string",
"packingGroup": "string",
"properShippingName": "string"
},
"freightClass": "string",
"imageUrl": "http://example.com"
}
]
}

Response samples

200
401
403

Content type

application/json

{"created": 0,
"updated": 0,
"errors": [{"index": 0,
"itemId": "string",
"error": "string"
}
]
}

Import items from CSV

Upload a CSV file to bulk import items. Max file size: 5 MB. Requires admin role.

Authorizations:

ApiKeyAuthBearerAuth

Request Body schema: multipart/form-data
required

file

required

string <binary>

Responses

Response samples

200
400
401
403

Content type

application/json

{"created": 0,
"updated": 0,
"errors": [{"index": 0,
"itemId": "string",
"error": "string"
}
]
}

Look up an item by external ID

Authorizations:

ApiKeyAuthBearerAuth

query Parameters

type required	string Example: type=sku External ID type (e.g. "sku", "upc", "ean")
value required	string Example: value=WIDGET-001 External ID value

Responses

Response samples

200
400
401
404

Content type

application/json

{"id": "string",
"name": "string",
"description": "string",
"externalIds": {"property1": "string",
"property2": "string"
},
"category": "string",
"tags": ["string"
],
"length": 0.1,
"width": 0.1,
"height": 0.1,
"weight": 0.1,
"unitOfMeasure": "string",
"shape": "string",
"shipAlone": true,
"packagingLevels": [{ }
],
"version": 0,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"createdBy": "string"
}

Get multiple items by ID

Retrieve up to 100 items in a single request.

Authorizations:

ApiKeyAuthBearerAuth

Request Body schema: application/json
required

itemIds

required

Array of strings [ 1 .. 100 ] items

Responses

Request samples

Payload

Content type

application/json

{"itemIds": ["WIDGET-001",
"GADGET-002"
]
}

Response samples

200
401

Content type

application/json

{"items": [{"id": "string",
"name": "string",
"description": "string",
"externalIds": {"property1": "string",
"property2": "string"
},
"category": "string",
"tags": ["string"
],
"length": 0.1,
"width": 0.1,
"height": 0.1,
"weight": 0.1,
"unitOfMeasure": "string",
"shape": "string",
"shipAlone": true,
"packagingLevels": [{ }
],
"version": 0,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"createdBy": "string"
}
]
}

Containers

Container Master CRUD and bulk operations

Create a container

Authorizations:

ApiKeyAuthBearerAuth

Request Body schema: application/json
required

id required	string [ 1 .. 128 ] characters
name required	string <= 256 characters
containerType required	string Enum: "Box" "Pallet" "Equipment"
description	string <= 2000 characters
subType	string <= 64 characters
tags	Array of strings
	object
innerLength required	number <double>
innerWidth required	number <double>
innerHeight required	number <double>
outerLength	number <double>
outerWidth	number <double>
outerHeight	number <double>
dimensionUnit	string <= 64 characters
weightTare	number <double>
weightMaxGross required	number <double> <= 200000
weightUnit	string <= 64 characters
isDynamic	boolean
minLength	number <double>
minWidth	number <double>
minHeight	number <double>
stackable	boolean
maxStackWeight	number <double>
material	string <= 64 characters
wallThickness	number <double>
baseCost	number <double>
isActive	boolean Default: true
	object
	object

Responses

Request samples

Payload

Content type

application/json

{"id": "BOX-MEDIUM",
"name": "Medium Box",
"containerType": "Box",
"innerLength": 20,
"innerWidth": 15,
"innerHeight": 12,
"weightMaxGross": 50
}

Response samples

201
401
409

Content type

application/json

{"id": "string",
"name": "string",
"containerType": "Box",
"innerLength": 0.1,
"innerWidth": 0.1,
"innerHeight": 0.1,
"weightMaxGross": 0.1,
"weightTare": 0.1,
"isDynamic": true,
"isActive": true,
"tags": ["string"
],
"version": 0,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}

List containers

Authorizations:

ApiKeyAuthBearerAuth

query Parameters

containerType	string Enum: "Box" "Pallet" "Equipment" Filter by container type
search	string Search by ID or name
tags	string Comma-separated tags
isActive	boolean Filter by active status
limit	integer [ 1 .. 100 ] Default: 20 Maximum number of items to return
cursor	string Opaque pagination cursor from a previous response's `nextCursor`

Responses

Response samples

200
401

Content type

application/json

{"items": [{"id": "string",
"name": "string",
"containerType": "Box",
"innerLength": 0.1,
"innerWidth": 0.1,
"innerHeight": 0.1,
"weightMaxGross": 0.1,
"weightTare": 0.1,
"isDynamic": true,
"isActive": true,
"tags": ["string"
],
"version": 0,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"nextCursor": "string"
}

Get a container by ID

Authorizations:

ApiKeyAuthBearerAuth

path Parameters

containerId

required

string

Responses

Response samples

200
401
404

Content type

application/json

{"id": "string",
"name": "string",
"containerType": "Box",
"innerLength": 0.1,
"innerWidth": 0.1,
"innerHeight": 0.1,
"weightMaxGross": 0.1,
"weightTare": 0.1,
"isDynamic": true,
"isActive": true,
"tags": ["string"
],
"version": 0,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}

Partially update a container

Requires the current version for optimistic concurrency.

Authorizations:

ApiKeyAuthBearerAuth

path Parameters

containerId

required

string

Request Body schema: application/json
required

version required	integer >= 1
name	string <= 256 characters
description	string <= 2000 characters
innerLength	number <double>
innerWidth	number <double>
innerHeight	number <double>
weightMaxGross	number <double>
isActive	boolean

Responses

Request samples

Payload

Content type

application/json

{"version": 1,
"weightMaxGross": 55
}

Response samples

200
401
404
409

Content type

application/json

{"id": "string",
"name": "string",
"containerType": "Box",
"innerLength": 0.1,
"innerWidth": 0.1,
"innerHeight": 0.1,
"weightMaxGross": 0.1,
"weightTare": 0.1,
"isDynamic": true,
"isActive": true,
"tags": ["string"
],
"version": 0,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}

Delete a container

Requires admin role.

Authorizations:

ApiKeyAuthBearerAuth

path Parameters

containerId

required

string

Responses

Response samples

401
403
404

Content type

application/problem+json

{"type": "https://developers.fractalpack.com/errors/unauthorized",
"title": "Unauthorized",
"status": 401,
"detail": "Invalid or missing authentication credentials.",
"instance": "0HN9A1B2C3D4:00000002",
"doc_url": "https://developers.fractalpack.com/errors/unauthorized"
}

Bulk import containers

Import up to 1,000 containers. Existing containers (by ID) are updated; new ones are created. Requires admin role.

Authorizations:

ApiKeyAuthBearerAuth

Request Body schema: application/json
required

required

Array of objects (CreateContainerRequest) [ 1 .. 1000 ] items

Responses

Request samples

Payload

Content type

application/json

{"containers": [{"id": "string",
"name": "string",
"containerType": "Box",
"description": "string",
"subType": "string",
"tags": ["string"
],
"customAttributes": { },
"innerLength": 0.1,
"innerWidth": 0.1,
"innerHeight": 0.1,
"outerLength": 0.1,
"outerWidth": 0.1,
"outerHeight": 0.1,
"dimensionUnit": "string",
"weightTare": 0.1,
"weightMaxGross": 200000,
"weightUnit": "string",
"isDynamic": true,
"minLength": 0.1,
"minWidth": 0.1,
"minHeight": 0.1,
"stackable": true,
"maxStackWeight": 0.1,
"material": "string",
"wallThickness": 0.1,
"baseCost": 0.1,
"isActive": true,
"palletProperties": {"platformHeight": 0.1,
"deckType": "string"
},
"equipmentProperties": {"equipmentType": "string"
}
}
]
}

Response samples

200
401
403

Content type

application/json

{"created": 0,
"updated": 0,
"errors": [{"index": 0,
"containerId": "string",
"error": "string"
}
]
}

Import containers from CSV

Max file size: 5 MB. Requires admin role.

Authorizations:

ApiKeyAuthBearerAuth

Request Body schema: multipart/form-data
required

file

required

string <binary>

Responses

Response samples

200
400
401
403

Content type

application/json

{"created": 0,
"updated": 0,
"errors": [{"index": 0,
"containerId": "string",
"error": "string"
}
]
}

Orders

Order lifecycle management

Create an order

Authorizations:

ApiKeyAuthBearerAuth

Request Body schema: application/json
required

sourceSystem	string <= 128 characters
sourceOrderId	string <= 128 characters
orderType	string Default: "Outbound" Enum: "Outbound" "Inbound" "Transfer" "Return"
priority	string Default: "Standard" Enum: "Standard" "High" "Urgent" "Critical"
serviceLevel	string Default: "Standard" Enum: "Economy" "Standard" "Expedited" "NextDay" "SameDay"
channel	string <= 128 characters
	object (AddressParty)
	object (AddressParty)
	object
orderedAt	string <date-time>
requiredShipBy	string <date-time>
requiredDeliverBy	string <date-time>
	Array of objects
tags	Array of strings
	object
externalShipmentId	string <= 128 characters Host system consolidation signal
submit	boolean Default: true If true, order created in RECEIVED status; if false, DRAFT
required	Array of objects (CreateOrderLineRequest) [ 1 .. 200 ] items

Responses

Request samples

Payload

Content type

application/json

{"sourceOrderId": "SO-2026-001",
"orderType": "Outbound",
"priority": "Standard",
"shipTo": {"name": "Acme Corp",
"addressLine1": "123 Main St",
"city": "Springfield",
"state": "IL",
"postalCode": "62701",
"country": "US"
},
"lines": [{"sku": "WIDGET-001",
"quantityOrdered": 5,
"length": 10,
"width": 8,
"height": 6,
"weight": 2.5
}
]
}

Response samples

201
400
401

Content type

application/json

{"id": "string",
"sourceSystem": "string",
"sourceOrderId": "string",
"orderType": "string",
"priority": "string",
"serviceLevel": "string",
"status": "Draft",
"channel": "string",
"shipFrom": {"name": "string",
"company": "string",
"addressLine1": "string",
"addressLine2": "string",
"city": "string",
"state": "string",
"postalCode": "string",
"country": "string",
"phone": "string",
"email": "string"
},
"shipTo": {"name": "string",
"company": "string",
"addressLine1": "string",
"addressLine2": "string",
"city": "string",
"state": "string",
"postalCode": "string",
"country": "string",
"phone": "string",
"email": "string"
},
"lines": [{ }
],
"tags": ["string"
],
"version": 0,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}

List orders

Authorizations:

ApiKeyAuthBearerAuth

query Parameters

status	string Enum: "Draft" "Received" "Planned" "Cancelled" Filter by order status
limit	integer [ 1 .. 100 ] Default: 20 Maximum number of items to return
cursor	string Opaque pagination cursor from a previous response's `nextCursor`

Responses

Response samples

200
401

Content type

application/json

{"items": [{"id": "string",
"sourceSystem": "string",
"sourceOrderId": "string",
"orderType": "string",
"priority": "string",
"serviceLevel": "string",
"status": "Draft",
"channel": "string",
"shipFrom": {"name": "string",
"company": "string",
"addressLine1": "string",
"addressLine2": "string",
"city": "string",
"state": "string",
"postalCode": "string",
"country": "string",
"phone": "string",
"email": "string"
},
"shipTo": {"name": "string",
"company": "string",
"addressLine1": "string",
"addressLine2": "string",
"city": "string",
"state": "string",
"postalCode": "string",
"country": "string",
"phone": "string",
"email": "string"
},
"lines": [{ }
],
"tags": ["string"
],
"version": 0,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"nextCursor": "string"
}

Get an order by ID

Authorizations:

ApiKeyAuthBearerAuth

path Parameters

orderId

required

string

Responses

Response samples

200
401
404

Content type

application/json

{"id": "string",
"sourceSystem": "string",
"sourceOrderId": "string",
"orderType": "string",
"priority": "string",
"serviceLevel": "string",
"status": "Draft",
"channel": "string",
"shipFrom": {"name": "string",
"company": "string",
"addressLine1": "string",
"addressLine2": "string",
"city": "string",
"state": "string",
"postalCode": "string",
"country": "string",
"phone": "string",
"email": "string"
},
"shipTo": {"name": "string",
"company": "string",
"addressLine1": "string",
"addressLine2": "string",
"city": "string",
"state": "string",
"postalCode": "string",
"country": "string",
"phone": "string",
"email": "string"
},
"lines": [{ }
],
"tags": ["string"
],
"version": 0,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}

Update an order

Requires the current version for optimistic concurrency.

Authorizations:

ApiKeyAuthBearerAuth

path Parameters

orderId

required

string

Request Body schema: application/json
required

version required	integer
priority	string Enum: "Standard" "High" "Urgent" "Critical"
serviceLevel	string Enum: "Economy" "Standard" "Expedited" "NextDay" "SameDay"
channel	string
	object (AddressParty)
	object (AddressParty)
requiredShipBy	string <date-time>
requiredDeliverBy	string <date-time>
tags	Array of strings
	Array of objects (CreateOrderLineRequest)

Responses

Request samples

Payload

Content type

application/json

{"version": 0,
"priority": "Standard",
"serviceLevel": "Economy",
"channel": "string",
"shipFrom": {"name": "string",
"company": "string",
"addressLine1": "string",
"addressLine2": "string",
"city": "string",
"state": "string",
"postalCode": "string",
"country": "string",
"phone": "string",
"email": "string"
},
"shipTo": {"name": "string",
"company": "string",
"addressLine1": "string",
"addressLine2": "string",
"city": "string",
"state": "string",
"postalCode": "string",
"country": "string",
"phone": "string",
"email": "string"
},
"requiredShipBy": "2019-08-24T14:15:22Z",
"requiredDeliverBy": "2019-08-24T14:15:22Z",
"tags": ["string"
],
"lines": [{"lineNumber": 0,
"itemId": "string",
"sku": "string",
"description": "string",
"quantityOrdered": 0,
"unitOfMeasure": "EA",
"length": 0.1,
"width": 0.1,
"height": 0.1,
"weight": 0.1,
"tags": ["string"
],
"specialInstructions": "string",
"lotNumber": "string",
"serialNumbers": ["string"
]
}
]
}

Response samples

200
400
401
404
409

Content type

application/json

{"id": "string",
"sourceSystem": "string",
"sourceOrderId": "string",
"orderType": "string",
"priority": "string",
"serviceLevel": "string",
"status": "Draft",
"channel": "string",
"shipFrom": {"name": "string",
"company": "string",
"addressLine1": "string",
"addressLine2": "string",
"city": "string",
"state": "string",
"postalCode": "string",
"country": "string",
"phone": "string",
"email": "string"
},
"shipTo": {"name": "string",
"company": "string",
"addressLine1": "string",
"addressLine2": "string",
"city": "string",
"state": "string",
"postalCode": "string",
"country": "string",
"phone": "string",
"email": "string"
},
"lines": [{ }
],
"tags": ["string"
],
"version": 0,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}

Cancel an order

Sets the order status to Cancelled.

Authorizations:

ApiKeyAuthBearerAuth

path Parameters

orderId

required

string

Responses

Response samples

200
401
404

Content type

application/json

{"id": "string",
"sourceSystem": "string",
"sourceOrderId": "string",
"orderType": "string",
"priority": "string",
"serviceLevel": "string",
"status": "Draft",
"channel": "string",
"shipFrom": {"name": "string",
"company": "string",
"addressLine1": "string",
"addressLine2": "string",
"city": "string",
"state": "string",
"postalCode": "string",
"country": "string",
"phone": "string",
"email": "string"
},
"shipTo": {"name": "string",
"company": "string",
"addressLine1": "string",
"addressLine2": "string",
"city": "string",
"state": "string",
"postalCode": "string",
"country": "string",
"phone": "string",
"email": "string"
},
"lines": [{ }
],
"tags": ["string"
],
"version": 0,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}

Revert an order to its previous status

Authorizations:

ApiKeyAuthBearerAuth

path Parameters

orderId

required

string

Responses

Response samples

200
400
401
404

Content type

application/json

{"id": "string",
"sourceSystem": "string",
"sourceOrderId": "string",
"orderType": "string",
"priority": "string",
"serviceLevel": "string",
"status": "Draft",
"channel": "string",
"shipFrom": {"name": "string",
"company": "string",
"addressLine1": "string",
"addressLine2": "string",
"city": "string",
"state": "string",
"postalCode": "string",
"country": "string",
"phone": "string",
"email": "string"
},
"shipTo": {"name": "string",
"company": "string",
"addressLine1": "string",
"addressLine2": "string",
"city": "string",
"state": "string",
"postalCode": "string",
"country": "string",
"phone": "string",
"email": "string"
},
"lines": [{ }
],
"tags": ["string"
],
"version": 0,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}

Import orders from CSV

Upload a CSV file to import orders. Existing orders (by sourceOrderId) are updated; new orders are created. Max file size: 5 MB.

Authorizations:

ApiKeyAuthBearerAuth

Request Body schema: multipart/form-data
required

file

required

string <binary>

Responses

Response samples

200
400
401

Content type

application/json

{"ordersCreated": 0,
"ordersUpdated": 0,
"ordersUnchanged": 0,
"totalLines": 0,
"errors": [{"orderId": "string",
"error": "string"
}
]
}

Shipments

Shipment optimization, rating, and lifecycle

Create a shipment from orders

Creates a shipment from one or more orders. Items are resolved from the Item Master when orders reference itemIds.

Authorizations:

ApiKeyAuthBearerAuth

Request Body schema: application/json
required

orderIds required	Array of strings non-empty
packingConfig	object Optional packing configuration overrides
mode	string Enum: "Parcel" "Ltl" "Ftl" "Air" "Ocean" "Intermodal"
serviceLevel	string Enum: "Economy" "Standard" "Expedited" "NextDay" "SameDay"
carrier	string <= 128 characters

Responses

Request samples

Payload

Content type

application/json

{"orderIds": ["ord_abc123"
],
"mode": "Parcel",
"serviceLevel": "Standard"
}

Response samples

201
400
401
404
422

Content type

application/json

{"id": "string",
"orderIds": ["string"
],
"status": "string",
"mode": "string",
"serviceLevel": "string",
"carrier": "string",
"packResult": {"algorithm": "string",
"results": [{"containerId": "string",
"boxIndex": 0,
"containerDimensions": {"length": 0.1,
"width": 0.1,
"height": 0.1
},
"packedItems": [{"id": "string",
"coordinate": {"x": 0.1,
"y": 0.1,
"z": 0.1
},
"packedDimensions": {"length": 0.1,
"width": 0.1,
"height": 0.1
},
"weight": 0.1,
"tags": ["string"
],
"nestedItems": [{ }
],
"rollInfo": {"sourceItemId": "string",
"rollIndex": 0,
"totalRolls": 0,
"linearQuantityOnRoll": 0.1,
"outerDiameter": 0.1
},
"sourceOrderId": "string",
"sourceLineNumber": 0
}
],
"unpackedItems": [{"id": "string",
"dimensions": {"length": 0.1,
"width": 0.1,
"height": 0.1
},
"weight": 0.1,
"rollInfo": {"sourceItemId": "string",
"rollIndex": 0,
"totalRolls": 0,
"linearQuantityOnRoll": 0.1,
"outerDiameter": 0.1
},
"sourceOrderId": "string",
"sourceLineNumber": 0
}
],
"volumeUtilizationPercent": 0.1,
"totalWeight": 0.1,
"sourceOrderIds": ["string"
],
"costBreakdown": {"shippingCost": 0,
"boxCost": 0,
"totalCost": 0,
"billableWeight": 0.1,
"dimWeight": 0.1,
"actualWeight": 0.1,
"carrier": "string",
"service": "string",
"zone": 0
}
}
],
"palletResults": {"pallets": [{"palletId": "string",
"palletIndex": 0,
"palletDimensions": {"length": 0.1,
"width": 0.1,
"height": 0.1
},
"cartons": [{"cartonId": "string",
"coordinate": {"x": 0.1,
"y": 0.1,
"z": 0.1
},
"packedDimensions": {"length": 0.1,
"width": 0.1,
"height": 0.1
},
"weight": 0.1
}
],
"volumeUtilizationPercent": 0.1,
"totalWeight": 0.1,
"palletWeight": 0.1,
"platformHeight": 0.1
}
],
"unpalletizedCartons": [{"cartonId": "string",
"dimensions": {"length": 0.1,
"width": 0.1,
"height": 0.1
},
"weight": 0.1
}
]
},
"trailerResults": {"trailers": [{"trailerId": "string",
"trailerIndex": 0,
"equipmentType": "string",
"trailerDimensions": {"length": 0.1,
"width": 0.1,
"height": 0.1
},
"pallets": [{"palletId": "string",
"coordinate": {"x": 0.1,
"y": 0.1,
"z": 0.1
},
"palletDimensions": {"length": 0.1,
"width": 0.1,
"height": 0.1
},
"weight": 0.1,
"stackInfo": {"bottomPalletId": "string",
"topPalletId": "string",
"bottomHeight": 0.1,
"topHeight": 0.1
}
}
],
"floorLoadedCartons": [{"cartonId": "string",
"coordinate": {"x": 0.1,
"y": 0.1,
"z": 0.1
},
"packedDimensions": {"length": 0.1,
"width": 0.1,
"height": 0.1
},
"weight": 0.1
}
],
"volumeUtilizationPercent": 0.1,
"totalWeight": 0.1,
"tareWeight": 0.1
}
],
"unloadedPallets": [{"palletId": "string",
"dimensions": {"length": 0.1,
"width": 0.1,
"height": 0.1
},
"weight": 0.1
}
],
"unloadedCartons": [{"cartonId": "string",
"dimensions": {"length": 0.1,
"width": 0.1,
"height": 0.1
},
"weight": 0.1
}
]
},
"firedRules": [{"ruleId": "string",
"ruleName": "string",
"ruleType": "string",
"summary": "string"
}
]
},
"version": 0,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}

List shipments

Authorizations:

ApiKeyAuthBearerAuth

query Parameters

status	string Filter by shipment status
orderId	string Filter by order ID
limit	integer [ 1 .. 100 ] Default: 20 Maximum number of items to return
cursor	string Opaque pagination cursor from a previous response's `nextCursor`

Responses

Response samples

200
401

Content type

application/json

{"items": [{"id": "string",
"orderIds": ["string"
],
"status": "string",
"mode": "string",
"serviceLevel": "string",
"carrier": "string",
"packResult": {"algorithm": "string",
"results": [{"containerId": "string",
"boxIndex": 0,
"containerDimensions": {"length": 0.1,
"width": 0.1,
"height": 0.1
},
"packedItems": [{"id": "string",
"coordinate": {"x": 0.1,
"y": 0.1,
"z": 0.1
},
"packedDimensions": {"length": 0.1,
"width": 0.1,
"height": 0.1
},
"weight": 0.1,
"tags": ["string"
],
"nestedItems": [{ }
],
"rollInfo": {"sourceItemId": "string",
"rollIndex": 0,
"totalRolls": 0,
"linearQuantityOnRoll": 0.1,
"outerDiameter": 0.1
},
"sourceOrderId": "string",
"sourceLineNumber": 0
}
],
"unpackedItems": [{"id": "string",
"dimensions": {"length": 0.1,
"width": 0.1,
"height": 0.1
},
"weight": 0.1,
"rollInfo": {"sourceItemId": "string",
"rollIndex": 0,
"totalRolls": 0,
"linearQuantityOnRoll": 0.1,
"outerDiameter": 0.1
},
"sourceOrderId": "string",
"sourceLineNumber": 0
}
],
"volumeUtilizationPercent": 0.1,
"totalWeight": 0.1,
"sourceOrderIds": ["string"
],
"costBreakdown": {"shippingCost": 0,
"boxCost": 0,
"totalCost": 0,
"billableWeight": 0.1,
"dimWeight": 0.1,
"actualWeight": 0.1,
"carrier": "string",
"service": "string",
"zone": 0
}
}
],
"palletResults": {"pallets": [{"palletId": "string",
"palletIndex": 0,
"palletDimensions": {"length": 0.1,
"width": 0.1,
"height": 0.1
},
"cartons": [{"cartonId": "string",
"coordinate": {"x": null,
"y": null,
"z": null
},
"packedDimensions": {"length": null,
"width": null,
"height": null
},
"weight": 0.1
}
],
"volumeUtilizationPercent": 0.1,
"totalWeight": 0.1,
"palletWeight": 0.1,
"platformHeight": 0.1
}
],
"unpalletizedCartons": [{"cartonId": "string",
"dimensions": {"length": 0.1,
"width": 0.1,
"height": 0.1
},
"weight": 0.1
}
]
},
"trailerResults": {"trailers": [{"trailerId": "string",
"trailerIndex": 0,
"equipmentType": "string",
"trailerDimensions": {"length": 0.1,
"width": 0.1,
"height": 0.1
},
"pallets": [{"palletId": "string",
"coordinate": {"x": null,
"y": null,
"z": null
},
"palletDimensions": {"length": null,
"width": null,
"height": null
},
"weight": 0.1,
"stackInfo": {"bottomPalletId": null,
"topPalletId": null,
"bottomHeight": null,
"topHeight": null
}
}
],
"floorLoadedCartons": [{"cartonId": "string",
"coordinate": {"x": null,
"y": null,
"z": null
},
"packedDimensions": {"length": null,
"width": null,
"height": null
},
"weight": 0.1
}
],
"volumeUtilizationPercent": 0.1,
"totalWeight": 0.1,
"tareWeight": 0.1
}
],
"unloadedPallets": [{"palletId": "string",
"dimensions": {"length": 0.1,
"width": 0.1,
"height": 0.1
},
"weight": 0.1
}
],
"unloadedCartons": [{"cartonId": "string",
"dimensions": {"length": 0.1,
"width": 0.1,
"height": 0.1
},
"weight": 0.1
}
]
},
"firedRules": [{"ruleId": "string",
"ruleName": "string",
"ruleType": "string",
"summary": "string"
}
]
},
"version": 0,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"nextCursor": "string"
}

Get a shipment by ID

Authorizations:

ApiKeyAuthBearerAuth

path Parameters

shipmentId

required

string

Responses

Response samples

200
401
404

Content type

application/json

{"id": "string",
"orderIds": ["string"
],
"status": "string",
"mode": "string",
"serviceLevel": "string",
"carrier": "string",
"packResult": {"algorithm": "string",
"results": [{"containerId": "string",
"boxIndex": 0,
"containerDimensions": {"length": 0.1,
"width": 0.1,
"height": 0.1
},
"packedItems": [{"id": "string",
"coordinate": {"x": 0.1,
"y": 0.1,
"z": 0.1
},
"packedDimensions": {"length": 0.1,
"width": 0.1,
"height": 0.1
},
"weight": 0.1,
"tags": ["string"
],
"nestedItems": [{ }
],
"rollInfo": {"sourceItemId": "string",
"rollIndex": 0,
"totalRolls": 0,
"linearQuantityOnRoll": 0.1,
"outerDiameter": 0.1
},
"sourceOrderId": "string",
"sourceLineNumber": 0
}
],
"unpackedItems": [{"id": "string",
"dimensions": {"length": 0.1,
"width": 0.1,
"height": 0.1
},
"weight": 0.1,
"rollInfo": {"sourceItemId": "string",
"rollIndex": 0,
"totalRolls": 0,
"linearQuantityOnRoll": 0.1,
"outerDiameter": 0.1
},
"sourceOrderId": "string",
"sourceLineNumber": 0
}
],
"volumeUtilizationPercent": 0.1,
"totalWeight": 0.1,
"sourceOrderIds": ["string"
],
"costBreakdown": {"shippingCost": 0,
"boxCost": 0,
"totalCost": 0,
"billableWeight": 0.1,
"dimWeight": 0.1,
"actualWeight": 0.1,
"carrier": "string",
"service": "string",
"zone": 0
}
}
],
"palletResults": {"pallets": [{"palletId": "string",
"palletIndex": 0,
"palletDimensions": {"length": 0.1,
"width": 0.1,
"height": 0.1
},
"cartons": [{"cartonId": "string",
"coordinate": {"x": 0.1,
"y": 0.1,
"z": 0.1
},
"packedDimensions": {"length": 0.1,
"width": 0.1,
"height": 0.1
},
"weight": 0.1
}
],
"volumeUtilizationPercent": 0.1,
"totalWeight": 0.1,
"palletWeight": 0.1,
"platformHeight": 0.1
}
],
"unpalletizedCartons": [{"cartonId": "string",
"dimensions": {"length": 0.1,
"width": 0.1,
"height": 0.1
},
"weight": 0.1
}
]
},
"trailerResults": {"trailers": [{"trailerId": "string",
"trailerIndex": 0,
"equipmentType": "string",
"trailerDimensions": {"length": 0.1,
"width": 0.1,
"height": 0.1
},
"pallets": [{"palletId": "string",
"coordinate": {"x": 0.1,
"y": 0.1,
"z": 0.1
},
"palletDimensions": {"length": 0.1,
"width": 0.1,
"height": 0.1
},
"weight": 0.1,
"stackInfo": {"bottomPalletId": "string",
"topPalletId": "string",
"bottomHeight": 0.1,
"topHeight": 0.1
}
}
],
"floorLoadedCartons": [{"cartonId": "string",
"coordinate": {"x": 0.1,
"y": 0.1,
"z": 0.1
},
"packedDimensions": {"length": 0.1,
"width": 0.1,
"height": 0.1
},
"weight": 0.1
}
],
"volumeUtilizationPercent": 0.1,
"totalWeight": 0.1,
"tareWeight": 0.1
}
],
"unloadedPallets": [{"palletId": "string",
"dimensions": {"length": 0.1,
"width": 0.1,
"height": 0.1
},
"weight": 0.1
}
],
"unloadedCartons": [{"cartonId": "string",
"dimensions": {"length": 0.1,
"width": 0.1,
"height": 0.1
},
"weight": 0.1
}
]
},
"firedRules": [{"ruleId": "string",
"ruleName": "string",
"ruleType": "string",
"summary": "string"
}
]
},
"version": 0,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}

Update a shipment

Authorizations:

ApiKeyAuthBearerAuth

path Parameters

shipmentId

required

string

Request Body schema: application/json
required

version required	integer
packingConfig	object
mode	string Enum: "Parcel" "Ltl" "Ftl" "Air" "Ocean" "Intermodal"
serviceLevel	string Enum: "Economy" "Standard" "Expedited" "NextDay" "SameDay"
carrier	string <= 128 characters

Responses

Request samples

Payload

Content type

application/json

{"version": 0,
"packingConfig": { },
"mode": "Parcel",
"serviceLevel": "Economy",
"carrier": "string"
}

Response samples

200
400
401
404
409

Content type

application/json

{"id": "string",
"orderIds": ["string"
],
"status": "string",
"mode": "string",
"serviceLevel": "string",
"carrier": "string",
"packResult": {"algorithm": "string",
"results": [{"containerId": "string",
"boxIndex": 0,
"containerDimensions": {"length": 0.1,
"width": 0.1,
"height": 0.1
},
"packedItems": [{"id": "string",
"coordinate": {"x": 0.1,
"y": 0.1,
"z": 0.1
},
"packedDimensions": {"length": 0.1,
"width": 0.1,
"height": 0.1
},
"weight": 0.1,
"tags": ["string"
],
"nestedItems": [{ }
],
"rollInfo": {"sourceItemId": "string",
"rollIndex": 0,
"totalRolls": 0,
"linearQuantityOnRoll": 0.1,
"outerDiameter": 0.1
},
"sourceOrderId": "string",
"sourceLineNumber": 0
}
],
"unpackedItems": [{"id": "string",
"dimensions": {"length": 0.1,
"width": 0.1,
"height": 0.1
},
"weight": 0.1,
"rollInfo": {"sourceItemId": "string",
"rollIndex": 0,
"totalRolls": 0,
"linearQuantityOnRoll": 0.1,
"outerDiameter": 0.1
},
"sourceOrderId": "string",
"sourceLineNumber": 0
}
],
"volumeUtilizationPercent": 0.1,
"totalWeight": 0.1,
"sourceOrderIds": ["string"
],
"costBreakdown": {"shippingCost": 0,
"boxCost": 0,
"totalCost": 0,
"billableWeight": 0.1,
"dimWeight": 0.1,
"actualWeight": 0.1,
"carrier": "string",
"service": "string",
"zone": 0
}
}
],
"palletResults": {"pallets": [{"palletId": "string",
"palletIndex": 0,
"palletDimensions": {"length": 0.1,
"width": 0.1,
"height": 0.1
},
"cartons": [{"cartonId": "string",
"coordinate": {"x": 0.1,
"y": 0.1,
"z": 0.1
},
"packedDimensions": {"length": 0.1,
"width": 0.1,
"height": 0.1
},
"weight": 0.1
}
],
"volumeUtilizationPercent": 0.1,
"totalWeight": 0.1,
"palletWeight": 0.1,
"platformHeight": 0.1
}
],
"unpalletizedCartons": [{"cartonId": "string",
"dimensions": {"length": 0.1,
"width": 0.1,
"height": 0.1
},
"weight": 0.1
}
]
},
"trailerResults": {"trailers": [{"trailerId": "string",
"trailerIndex": 0,
"equipmentType": "string",
"trailerDimensions": {"length": 0.1,
"width": 0.1,
"height": 0.1
},
"pallets": [{"palletId": "string",
"coordinate": {"x": 0.1,
"y": 0.1,
"z": 0.1
},
"palletDimensions": {"length": 0.1,
"width": 0.1,
"height": 0.1
},
"weight": 0.1,
"stackInfo": {"bottomPalletId": "string",
"topPalletId": "string",
"bottomHeight": 0.1,
"topHeight": 0.1
}
}
],
"floorLoadedCartons": [{"cartonId": "string",
"coordinate": {"x": 0.1,
"y": 0.1,
"z": 0.1
},
"packedDimensions": {"length": 0.1,
"width": 0.1,
"height": 0.1
},
"weight": 0.1
}
],
"volumeUtilizationPercent": 0.1,
"totalWeight": 0.1,
"tareWeight": 0.1
}
],
"unloadedPallets": [{"palletId": "string",
"dimensions": {"length": 0.1,
"width": 0.1,
"height": 0.1
},
"weight": 0.1
}
],
"unloadedCartons": [{"cartonId": "string",
"dimensions": {"length": 0.1,
"width": 0.1,
"height": 0.1
},
"weight": 0.1
}
]
},
"firedRules": [{"ruleId": "string",
"ruleName": "string",
"ruleType": "string",
"summary": "string"
}
]
},
"version": 0,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}

Cancel a shipment

Authorizations:

ApiKeyAuthBearerAuth

path Parameters

shipmentId

required

string

Responses

Response samples

200
401
404

Content type

application/json

{"id": "string",
"orderIds": ["string"
],
"status": "string",
"mode": "string",
"serviceLevel": "string",
"carrier": "string",
"packResult": {"algorithm": "string",
"results": [{"containerId": "string",
"boxIndex": 0,
"containerDimensions": {"length": 0.1,
"width": 0.1,
"height": 0.1
},
"packedItems": [{"id": "string",
"coordinate": {"x": 0.1,
"y": 0.1,
"z": 0.1
},
"packedDimensions": {"length": 0.1,
"width": 0.1,
"height": 0.1
},
"weight": 0.1,
"tags": ["string"
],
"nestedItems": [{ }
],
"rollInfo": {"sourceItemId": "string",
"rollIndex": 0,
"totalRolls": 0,
"linearQuantityOnRoll": 0.1,
"outerDiameter": 0.1
},
"sourceOrderId": "string",
"sourceLineNumber": 0
}
],
"unpackedItems": [{"id": "string",
"dimensions": {"length": 0.1,
"width": 0.1,
"height": 0.1
},
"weight": 0.1,
"rollInfo": {"sourceItemId": "string",
"rollIndex": 0,
"totalRolls": 0,
"linearQuantityOnRoll": 0.1,
"outerDiameter": 0.1
},
"sourceOrderId": "string",
"sourceLineNumber": 0
}
],
"volumeUtilizationPercent": 0.1,
"totalWeight": 0.1,
"sourceOrderIds": ["string"
],
"costBreakdown": {"shippingCost": 0,
"boxCost": 0,
"totalCost": 0,
"billableWeight": 0.1,
"dimWeight": 0.1,
"actualWeight": 0.1,
"carrier": "string",
"service": "string",
"zone": 0
}
}
],
"palletResults": {"pallets": [{"palletId": "string",
"palletIndex": 0,
"palletDimensions": {"length": 0.1,
"width": 0.1,
"height": 0.1
},
"cartons": [{"cartonId": "string",
"coordinate": {"x": 0.1,
"y": 0.1,
"z": 0.1
},
"packedDimensions": {"length": 0.1,
"width": 0.1,
"height": 0.1
},
"weight": 0.1
}
],
"volumeUtilizationPercent": 0.1,
"totalWeight": 0.1,
"palletWeight": 0.1,
"platformHeight": 0.1
}
],
"unpalletizedCartons": [{"cartonId": "string",
"dimensions": {"length": 0.1,
"width": 0.1,
"height": 0.1
},
"weight": 0.1
}
]
},
"trailerResults": {"trailers": [{"trailerId": "string",
"trailerIndex": 0,
"equipmentType": "string",
"trailerDimensions": {"length": 0.1,
"width": 0.1,
"height": 0.1
},
"pallets": [{"palletId": "string",
"coordinate": {"x": 0.1,
"y": 0.1,
"z": 0.1
},
"palletDimensions": {"length": 0.1,
"width": 0.1,
"height": 0.1
},
"weight": 0.1,
"stackInfo": {"bottomPalletId": "string",
"topPalletId": "string",
"bottomHeight": 0.1,
"topHeight": 0.1
}
}
],
"floorLoadedCartons": [{"cartonId": "string",
"coordinate": {"x": 0.1,
"y": 0.1,
"z": 0.1
},
"packedDimensions": {"length": 0.1,
"width": 0.1,
"height": 0.1
},
"weight": 0.1
}
],
"volumeUtilizationPercent": 0.1,
"totalWeight": 0.1,
"tareWeight": 0.1
}
],
"unloadedPallets": [{"palletId": "string",
"dimensions": {"length": 0.1,
"width": 0.1,
"height": 0.1
},
"weight": 0.1
}
],
"unloadedCartons": [{"cartonId": "string",
"dimensions": {"length": 0.1,
"width": 0.1,
"height": 0.1
},
"weight": 0.1
}
]
},
"firedRules": [{"ruleId": "string",
"ruleName": "string",
"ruleType": "string",
"summary": "string"
}
]
},
"version": 0,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}

Run packing optimization on a shipment

Runs the 3D bin-packing algorithm on the shipment's items and updates the shipment with the pack result.

Authorizations:

ApiKeyAuthBearerAuth

path Parameters

shipmentId

required

string

Request Body schema: application/json

algorithm

string <= 64 characters

Packing algorithm to use

Responses

Request samples

Payload

Content type

application/json

{"algorithm": "ebAfit"
}

Response samples

200
400
401
404

Content type

application/json

{"id": "string",
"orderIds": ["string"
],
"status": "string",
"mode": "string",
"serviceLevel": "string",
"carrier": "string",
"packResult": {"algorithm": "string",
"results": [{"containerId": "string",
"boxIndex": 0,
"containerDimensions": {"length": 0.1,
"width": 0.1,
"height": 0.1
},
"packedItems": [{"id": "string",
"coordinate": {"x": 0.1,
"y": 0.1,
"z": 0.1
},
"packedDimensions": {"length": 0.1,
"width": 0.1,
"height": 0.1
},
"weight": 0.1,
"tags": ["string"
],
"nestedItems": [{ }
],
"rollInfo": {"sourceItemId": "string",
"rollIndex": 0,
"totalRolls": 0,
"linearQuantityOnRoll": 0.1,
"outerDiameter": 0.1
},
"sourceOrderId": "string",
"sourceLineNumber": 0
}
],
"unpackedItems": [{"id": "string",
"dimensions": {"length": 0.1,
"width": 0.1,
"height": 0.1
},
"weight": 0.1,
"rollInfo": {"sourceItemId": "string",
"rollIndex": 0,
"totalRolls": 0,
"linearQuantityOnRoll": 0.1,
"outerDiameter": 0.1
},
"sourceOrderId": "string",
"sourceLineNumber": 0
}
],
"volumeUtilizationPercent": 0.1,
"totalWeight": 0.1,
"sourceOrderIds": ["string"
],
"costBreakdown": {"shippingCost": 0,
"boxCost": 0,
"totalCost": 0,
"billableWeight": 0.1,
"dimWeight": 0.1,
"actualWeight": 0.1,
"carrier": "string",
"service": "string",
"zone": 0
}
}
],
"palletResults": {"pallets": [{"palletId": "string",
"palletIndex": 0,
"palletDimensions": {"length": 0.1,
"width": 0.1,
"height": 0.1
},
"cartons": [{"cartonId": "string",
"coordinate": {"x": 0.1,
"y": 0.1,
"z": 0.1
},
"packedDimensions": {"length": 0.1,
"width": 0.1,
"height": 0.1
},
"weight": 0.1
}
],
"volumeUtilizationPercent": 0.1,
"totalWeight": 0.1,
"palletWeight": 0.1,
"platformHeight": 0.1
}
],
"unpalletizedCartons": [{"cartonId": "string",
"dimensions": {"length": 0.1,
"width": 0.1,
"height": 0.1
},
"weight": 0.1
}
]
},
"trailerResults": {"trailers": [{"trailerId": "string",
"trailerIndex": 0,
"equipmentType": "string",
"trailerDimensions": {"length": 0.1,
"width": 0.1,
"height": 0.1
},
"pallets": [{"palletId": "string",
"coordinate": {"x": 0.1,
"y": 0.1,
"z": 0.1
},
"palletDimensions": {"length": 0.1,
"width": 0.1,
"height": 0.1
},
"weight": 0.1,
"stackInfo": {"bottomPalletId": "string",
"topPalletId": "string",
"bottomHeight": 0.1,
"topHeight": 0.1
}
}
],
"floorLoadedCartons": [{"cartonId": "string",
"coordinate": {"x": 0.1,
"y": 0.1,
"z": 0.1
},
"packedDimensions": {"length": 0.1,
"width": 0.1,
"height": 0.1
},
"weight": 0.1
}
],
"volumeUtilizationPercent": 0.1,
"totalWeight": 0.1,
"tareWeight": 0.1
}
],
"unloadedPallets": [{"palletId": "string",
"dimensions": {"length": 0.1,
"width": 0.1,
"height": 0.1
},
"weight": 0.1
}
],
"unloadedCartons": [{"cartonId": "string",
"dimensions": {"length": 0.1,
"width": 0.1,
"height": 0.1
},
"weight": 0.1
}
]
},
"firedRules": [{"ruleId": "string",
"ruleName": "string",
"ruleType": "string",
"summary": "string"
}
]
},
"version": 0,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}

Get shipping rates for a shipment

Fetches live shipping rates from connected carriers for the optimized shipment parcels.

Authorizations:

ApiKeyAuthBearerAuth

path Parameters

shipmentId

required

string

Request Body schema: application/json

carriers

Array of strings

Carrier IDs to rate (defaults to all connected)

Responses

Request samples

Payload

Content type

application/json

{"carriers": ["ups",
"fedex"
]
}

Response samples

200
400
401
404

Content type

application/json

{"id": "string",
"orderIds": ["string"
],
"status": "string",
"mode": "string",
"serviceLevel": "string",
"carrier": "string",
"packResult": {"algorithm": "string",
"results": [{"containerId": "string",
"boxIndex": 0,
"containerDimensions": {"length": 0.1,
"width": 0.1,
"height": 0.1
},
"packedItems": [{"id": "string",
"coordinate": {"x": 0.1,
"y": 0.1,
"z": 0.1
},
"packedDimensions": {"length": 0.1,
"width": 0.1,
"height": 0.1
},
"weight": 0.1,
"tags": ["string"
],
"nestedItems": [{ }
],
"rollInfo": {"sourceItemId": "string",
"rollIndex": 0,
"totalRolls": 0,
"linearQuantityOnRoll": 0.1,
"outerDiameter": 0.1
},
"sourceOrderId": "string",
"sourceLineNumber": 0
}
],
"unpackedItems": [{"id": "string",
"dimensions": {"length": 0.1,
"width": 0.1,
"height": 0.1
},
"weight": 0.1,
"rollInfo": {"sourceItemId": "string",
"rollIndex": 0,
"totalRolls": 0,
"linearQuantityOnRoll": 0.1,
"outerDiameter": 0.1
},
"sourceOrderId": "string",
"sourceLineNumber": 0
}
],
"volumeUtilizationPercent": 0.1,
"totalWeight": 0.1,
"sourceOrderIds": ["string"
],
"costBreakdown": {"shippingCost": 0,
"boxCost": 0,
"totalCost": 0,
"billableWeight": 0.1,
"dimWeight": 0.1,
"actualWeight": 0.1,
"carrier": "string",
"service": "string",
"zone": 0
}
}
],
"palletResults": {"pallets": [{"palletId": "string",
"palletIndex": 0,
"palletDimensions": {"length": 0.1,
"width": 0.1,
"height": 0.1
},
"cartons": [{"cartonId": "string",
"coordinate": {"x": 0.1,
"y": 0.1,
"z": 0.1
},
"packedDimensions": {"length": 0.1,
"width": 0.1,
"height": 0.1
},
"weight": 0.1
}
],
"volumeUtilizationPercent": 0.1,
"totalWeight": 0.1,
"palletWeight": 0.1,
"platformHeight": 0.1
}
],
"unpalletizedCartons": [{"cartonId": "string",
"dimensions": {"length": 0.1,
"width": 0.1,
"height": 0.1
},
"weight": 0.1
}
]
},
"trailerResults": {"trailers": [{"trailerId": "string",
"trailerIndex": 0,
"equipmentType": "string",
"trailerDimensions": {"length": 0.1,
"width": 0.1,
"height": 0.1
},
"pallets": [{"palletId": "string",
"coordinate": {"x": 0.1,
"y": 0.1,
"z": 0.1
},
"palletDimensions": {"length": 0.1,
"width": 0.1,
"height": 0.1
},
"weight": 0.1,
"stackInfo": {"bottomPalletId": "string",
"topPalletId": "string",
"bottomHeight": 0.1,
"topHeight": 0.1
}
}
],
"floorLoadedCartons": [{"cartonId": "string",
"coordinate": {"x": 0.1,
"y": 0.1,
"z": 0.1
},
"packedDimensions": {"length": 0.1,
"width": 0.1,
"height": 0.1
},
"weight": 0.1
}
],
"volumeUtilizationPercent": 0.1,
"totalWeight": 0.1,
"tareWeight": 0.1
}
],
"unloadedPallets": [{"palletId": "string",
"dimensions": {"length": 0.1,
"width": 0.1,
"height": 0.1
},
"weight": 0.1
}
],
"unloadedCartons": [{"cartonId": "string",
"dimensions": {"length": 0.1,
"width": 0.1,
"height": 0.1
},
"weight": 0.1
}
]
},
"firedRules": [{"ruleId": "string",
"ruleName": "string",
"ruleType": "string",
"summary": "string"
}
]
},
"version": 0,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}

Mark a shipment as ready

Transitions the shipment to the Ready state.

Authorizations:

ApiKeyAuthBearerAuth

path Parameters

shipmentId

required

string

Responses

Response samples

200
400
401
404

Content type

application/json

{"id": "string",
"orderIds": ["string"
],
"status": "string",
"mode": "string",
"serviceLevel": "string",
"carrier": "string",
"packResult": {"algorithm": "string",
"results": [{"containerId": "string",
"boxIndex": 0,
"containerDimensions": {"length": 0.1,
"width": 0.1,
"height": 0.1
},
"packedItems": [{"id": "string",
"coordinate": {"x": 0.1,
"y": 0.1,
"z": 0.1
},
"packedDimensions": {"length": 0.1,
"width": 0.1,
"height": 0.1
},
"weight": 0.1,
"tags": ["string"
],
"nestedItems": [{ }
],
"rollInfo": {"sourceItemId": "string",
"rollIndex": 0,
"totalRolls": 0,
"linearQuantityOnRoll": 0.1,
"outerDiameter": 0.1
},
"sourceOrderId": "string",
"sourceLineNumber": 0
}
],
"unpackedItems": [{"id": "string",
"dimensions": {"length": 0.1,
"width": 0.1,
"height": 0.1
},
"weight": 0.1,
"rollInfo": {"sourceItemId": "string",
"rollIndex": 0,
"totalRolls": 0,
"linearQuantityOnRoll": 0.1,
"outerDiameter": 0.1
},
"sourceOrderId": "string",
"sourceLineNumber": 0
}
],
"volumeUtilizationPercent": 0.1,
"totalWeight": 0.1,
"sourceOrderIds": ["string"
],
"costBreakdown": {"shippingCost": 0,
"boxCost": 0,
"totalCost": 0,
"billableWeight": 0.1,
"dimWeight": 0.1,
"actualWeight": 0.1,
"carrier": "string",
"service": "string",
"zone": 0
}
}
],
"palletResults": {"pallets": [{"palletId": "string",
"palletIndex": 0,
"palletDimensions": {"length": 0.1,
"width": 0.1,
"height": 0.1
},
"cartons": [{"cartonId": "string",
"coordinate": {"x": 0.1,
"y": 0.1,
"z": 0.1
},
"packedDimensions": {"length": 0.1,
"width": 0.1,
"height": 0.1
},
"weight": 0.1
}
],
"volumeUtilizationPercent": 0.1,
"totalWeight": 0.1,
"palletWeight": 0.1,
"platformHeight": 0.1
}
],
"unpalletizedCartons": [{"cartonId": "string",
"dimensions": {"length": 0.1,
"width": 0.1,
"height": 0.1
},
"weight": 0.1
}
]
},
"trailerResults": {"trailers": [{"trailerId": "string",
"trailerIndex": 0,
"equipmentType": "string",
"trailerDimensions": {"length": 0.1,
"width": 0.1,
"height": 0.1
},
"pallets": [{"palletId": "string",
"coordinate": {"x": 0.1,
"y": 0.1,
"z": 0.1
},
"palletDimensions": {"length": 0.1,
"width": 0.1,
"height": 0.1
},
"weight": 0.1,
"stackInfo": {"bottomPalletId": "string",
"topPalletId": "string",
"bottomHeight": 0.1,
"topHeight": 0.1
}
}
],
"floorLoadedCartons": [{"cartonId": "string",
"coordinate": {"x": 0.1,
"y": 0.1,
"z": 0.1
},
"packedDimensions": {"length": 0.1,
"width": 0.1,
"height": 0.1
},
"weight": 0.1
}
],
"volumeUtilizationPercent": 0.1,
"totalWeight": 0.1,
"tareWeight": 0.1
}
],
"unloadedPallets": [{"palletId": "string",
"dimensions": {"length": 0.1,
"width": 0.1,
"height": 0.1
},
"weight": 0.1
}
],
"unloadedCartons": [{"cartonId": "string",
"dimensions": {"length": 0.1,
"width": 0.1,
"height": 0.1
},
"weight": 0.1
}
]
},
"firedRules": [{"ruleId": "string",
"ruleName": "string",
"ruleType": "string",
"summary": "string"
}
]
},
"version": 0,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}

Rules

Packing rules engine

List all packing rules

Authorizations:

ApiKeyAuthBearerAuth

Responses

Response samples

200
401

Content type

application/json

[{"id": "string",
"name": "string",
"description": "string",
"enabled": true,
"priority": 0,
"ruleType": "BoxSetFilter",
"executionTarget": "PreSolve",
"conditions": {"operator": "and",
"conditions": [{"field": "string",
"operator": "string",
"value": null
}
]
},
"action": {"type": "string",
"payload": null
},
"version": 0,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"createdBy": "string"
}
]

Create a packing rule

Authorizations:

ApiKeyAuthBearerAuth

Request Body schema: application/json
required

id	string <= 128 characters
name	string <= 256 characters
description	string <= 2000 characters
enabled	boolean Default: true
priority	integer Lower numbers execute first
ruleType	string Enum: "BoxSetFilter" "CarrierPackagingRule" "DestinationOverride" "OrderPreprocessing" "IncompatibilityGroup" "StackingConstraint" "OrientationRestriction" "ItemGrouping" "PostSolveValidation" "ObjectiveWeightModifier" "ReSolveTrigger" "ConsolidationProfile"
executionTarget	string Default: "PreSolve" Enum: "PreSolve" "SolverConfig" "PostSolve"
	object Condition group with operator and nested conditions
	object Rule action with type and payload
version	integer
createdAt	string <date-time>
updatedAt	string <date-time>
createdBy	string

Responses

Request samples

Payload

Content type

application/json

{"name": "Exclude small boxes for heavy items",
"ruleType": "BoxSetFilter",
"enabled": true,
"priority": 10,
"conditions": {"operator": "and",
"conditions": [{"field": "totalWeight",
"operator": "greaterThan",
"value": 50
}
]
},
"action": {"type": "BoxSetFilter",
"payload": {"exclude": ["SM-BOX"
]
}
}
}

Response samples

201
401

Content type

application/json

{"id": "string",
"name": "string",
"description": "string",
"enabled": true,
"priority": 0,
"ruleType": "BoxSetFilter",
"executionTarget": "PreSolve",
"conditions": {"operator": "and",
"conditions": [{"field": "string",
"operator": "string",
"value": null
}
]
},
"action": {"type": "string",
"payload": null
},
"version": 0,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"createdBy": "string"
}

Get a rule by ID

Authorizations:

ApiKeyAuthBearerAuth

path Parameters

id

required

string

Responses

Response samples

200
401
404

Content type

application/json

{"id": "string",
"name": "string",
"description": "string",
"enabled": true,
"priority": 0,
"ruleType": "BoxSetFilter",
"executionTarget": "PreSolve",
"conditions": {"operator": "and",
"conditions": [{"field": "string",
"operator": "string",
"value": null
}
]
},
"action": {"type": "string",
"payload": null
},
"version": 0,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"createdBy": "string"
}

Update a rule

Authorizations:

ApiKeyAuthBearerAuth

path Parameters

id

required

string

Request Body schema: application/json
required

id	string <= 128 characters
name	string <= 256 characters
description	string <= 2000 characters
enabled	boolean Default: true
priority	integer Lower numbers execute first
ruleType	string Enum: "BoxSetFilter" "CarrierPackagingRule" "DestinationOverride" "OrderPreprocessing" "IncompatibilityGroup" "StackingConstraint" "OrientationRestriction" "ItemGrouping" "PostSolveValidation" "ObjectiveWeightModifier" "ReSolveTrigger" "ConsolidationProfile"
executionTarget	string Default: "PreSolve" Enum: "PreSolve" "SolverConfig" "PostSolve"
	object Condition group with operator and nested conditions
	object Rule action with type and payload
version	integer
createdAt	string <date-time>
updatedAt	string <date-time>
createdBy	string

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"name": "string",
"description": "string",
"enabled": true,
"priority": 0,
"ruleType": "BoxSetFilter",
"executionTarget": "PreSolve",
"conditions": {"operator": "and",
"conditions": [{"field": "string",
"operator": "string",
"value": null
}
]
},
"action": {"type": "string",
"payload": null
},
"version": 0,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"createdBy": "string"
}

Response samples

200
401
404

Content type

application/json

{"id": "string",
"name": "string",
"description": "string",
"enabled": true,
"priority": 0,
"ruleType": "BoxSetFilter",
"executionTarget": "PreSolve",
"conditions": {"operator": "and",
"conditions": [{"field": "string",
"operator": "string",
"value": null
}
]
},
"action": {"type": "string",
"payload": null
},
"version": 0,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"createdBy": "string"
}

Delete a rule

Authorizations:

ApiKeyAuthBearerAuth

path Parameters

id

required

string

Responses

Response samples

401
404

Content type

application/problem+json

{"type": "https://developers.fractalpack.com/errors/unauthorized",
"title": "Unauthorized",
"status": 401,
"detail": "Invalid or missing authentication credentials.",
"instance": "0HN9A1B2C3D4:00000002",
"doc_url": "https://developers.fractalpack.com/errors/unauthorized"
}

Consolidation

Multi-order consolidation

Evaluate orders for consolidation

Analyzes a set of orders and suggests consolidation groups based on destination, shipping mode, and profile constraints.

Authorizations:

ApiKeyAuthBearerAuth

Request Body schema: application/json
required

orderIds required	Array of strings non-empty
profileId	string

Responses

Request samples

Payload

Content type

application/json

{"orderIds": ["ord_001",
"ord_002",
"ord_003"
],
"profileId": "prof_default"
}

Response samples

200
400
401

Content type

application/json

{"suggestedGroups": [{"orderIds": ["string"
],
"profileId": "string",
"groupingKeyValues": {"property1": "string",
"property2": "string"
}
}
],
"ungrouped": [{"orderId": "string",
"reason": "string"
}
]
}

Create a consolidation group

Groups orders for consolidated packing. Requires at least 2 orders. Set forceOverride: true to bypass validation warnings.

Authorizations:

ApiKeyAuthBearerAuth

Request Body schema: application/json
required

profileId	string <= 128 characters
	object
sourceOrderIds required	Array of strings >= 2 items
forceOverride	boolean Default: false Override validation warnings

Responses

Request samples

Payload

Content type

application/json

{"sourceOrderIds": ["ord_001",
"ord_002"
],
"profileId": "prof_default"
}

Response samples

201
401
409
422

Content type

application/json

{"id": "string",
"sourceOrderIds": ["string"
],
"profileId": "string",
"status": "Pending",
"groupingKeyValues": {"property1": "string",
"property2": "string"
},
"wasManualOverride": true,
"createdAt": "2019-08-24T14:15:22Z",
"createdBy": "string",
"version": 0
}

List consolidation groups

Authorizations:

ApiKeyAuthBearerAuth

query Parameters

limit	integer [ 1 .. 100 ] Default: 20 Maximum number of items to return
cursor	string Opaque pagination cursor from a previous response's `nextCursor`
status	string Enum: "Pending" "Packed" "Dissolved"

Responses

Response samples

200
401

Content type

application/json

{"items": [{"id": "string",
"sourceOrderIds": ["string"
],
"profileId": "string",
"status": "Pending",
"groupingKeyValues": {"property1": "string",
"property2": "string"
},
"wasManualOverride": true,
"createdAt": "2019-08-24T14:15:22Z",
"createdBy": "string",
"version": 0
}
],
"nextCursor": "string"
}

Get a consolidation group

Authorizations:

ApiKeyAuthBearerAuth

path Parameters

groupId

required

string

Responses

Response samples

200
401
404

Content type

application/json

{"id": "string",
"sourceOrderIds": ["string"
],
"profileId": "string",
"status": "Pending",
"groupingKeyValues": {"property1": "string",
"property2": "string"
},
"wasManualOverride": true,
"createdAt": "2019-08-24T14:15:22Z",
"createdBy": "string",
"version": 0
}

Dissolve a consolidation group

Returns member orders to their ungrouped state.

Authorizations:

ApiKeyAuthBearerAuth

path Parameters

groupId

required

string

Responses

Response samples

200
400
401
404

Content type

application/json

{"id": "string",
"sourceOrderIds": ["string"
],
"profileId": "string",
"status": "Pending",
"groupingKeyValues": {"property1": "string",
"property2": "string"
},
"wasManualOverride": true,
"createdAt": "2019-08-24T14:15:22Z",
"createdBy": "string",
"version": 0
}

Pack a consolidation group

Runs packing optimization on all orders in the group. Items from different orders can be mixed within containers unless the profile disallows it.

Authorizations:

ApiKeyAuthBearerAuth

path Parameters

groupId

required

string

Request Body schema: application/json
required

	Array of objects (ContainerDto)
	Array of objects (DynamicContainerDto)
	Array of objects (PalletDto)
	Array of objects (EquipmentDto)
algorithm	string <= 64 characters
loadingMode	string <= 64 characters
allowMultipleBoxes	boolean Default: true
allowPalletStacking	boolean Default: false

Responses

Request samples

Payload

Content type

application/json

{"containers": [{"id": "string",
"length": 0.1,
"width": 0.1,
"height": 0.1,
"maxWeight": 200000,
"cost": 0.1,
"carrierService": "string",
"flatRateCost": 0.1
}
],
"dynamicContainers": [{"id": "string",
"minLength": 0.1,
"minWidth": 0.1,
"minHeight": 0.1,
"maxLength": 0.1,
"maxWidth": 0.1,
"maxHeight": 0.1,
"maxWeight": 200000
}
],
"pallets": [{"id": "string",
"length": 0.1,
"width": 0.1,
"maxHeight": 0.1,
"palletWeight": 0.1,
"maxWeight": 200000,
"platformHeight": 0.1,
"maxStackWeight": 200000
}
],
"equipment": [{"id": "string",
"length": 0.1,
"width": 0.1,
"height": 0.1,
"tareWeight": 0.1,
"maxWeight": 200000,
"equipmentType": "DryVan"
}
],
"algorithm": "string",
"loadingMode": "string",
"allowMultipleBoxes": true,
"allowPalletStacking": false
}

Response samples

200
400
401
404

Content type

application/json

{"packResult": {"algorithm": "string",
"results": [{"containerId": "string",
"boxIndex": 0,
"containerDimensions": {"length": 0.1,
"width": 0.1,
"height": 0.1
},
"packedItems": [{"id": "string",
"coordinate": {"x": 0.1,
"y": 0.1,
"z": 0.1
},
"packedDimensions": {"length": 0.1,
"width": 0.1,
"height": 0.1
},
"weight": 0.1,
"tags": ["string"
],
"nestedItems": [{ }
],
"rollInfo": {"sourceItemId": "string",
"rollIndex": 0,
"totalRolls": 0,
"linearQuantityOnRoll": 0.1,
"outerDiameter": 0.1
},
"sourceOrderId": "string",
"sourceLineNumber": 0
}
],
"unpackedItems": [{"id": "string",
"dimensions": {"length": 0.1,
"width": 0.1,
"height": 0.1
},
"weight": 0.1,
"rollInfo": {"sourceItemId": "string",
"rollIndex": 0,
"totalRolls": 0,
"linearQuantityOnRoll": 0.1,
"outerDiameter": 0.1
},
"sourceOrderId": "string",
"sourceLineNumber": 0
}
],
"volumeUtilizationPercent": 0.1,
"totalWeight": 0.1,
"sourceOrderIds": ["string"
],
"costBreakdown": {"shippingCost": 0,
"boxCost": 0,
"totalCost": 0,
"billableWeight": 0.1,
"dimWeight": 0.1,
"actualWeight": 0.1,
"carrier": "string",
"service": "string",
"zone": 0
}
}
],
"palletResults": {"pallets": [{"palletId": "string",
"palletIndex": 0,
"palletDimensions": {"length": 0.1,
"width": 0.1,
"height": 0.1
},
"cartons": [{"cartonId": "string",
"coordinate": {"x": 0.1,
"y": 0.1,
"z": 0.1
},
"packedDimensions": {"length": 0.1,
"width": 0.1,
"height": 0.1
},
"weight": 0.1
}
],
"volumeUtilizationPercent": 0.1,
"totalWeight": 0.1,
"palletWeight": 0.1,
"platformHeight": 0.1
}
],
"unpalletizedCartons": [{"cartonId": "string",
"dimensions": {"length": 0.1,
"width": 0.1,
"height": 0.1
},
"weight": 0.1
}
]
},
"trailerResults": {"trailers": [{"trailerId": "string",
"trailerIndex": 0,
"equipmentType": "string",
"trailerDimensions": {"length": 0.1,
"width": 0.1,
"height": 0.1
},
"pallets": [{"palletId": "string",
"coordinate": {"x": 0.1,
"y": 0.1,
"z": 0.1
},
"palletDimensions": {"length": 0.1,
"width": 0.1,
"height": 0.1
},
"weight": 0.1,
"stackInfo": {"bottomPalletId": "string",
"topPalletId": "string",
"bottomHeight": 0.1,
"topHeight": 0.1
}
}
],
"floorLoadedCartons": [{"cartonId": "string",
"coordinate": {"x": 0.1,
"y": 0.1,
"z": 0.1
},
"packedDimensions": {"length": 0.1,
"width": 0.1,
"height": 0.1
},
"weight": 0.1
}
],
"volumeUtilizationPercent": 0.1,
"totalWeight": 0.1,
"tareWeight": 0.1
}
],
"unloadedPallets": [{"palletId": "string",
"dimensions": {"length": 0.1,
"width": 0.1,
"height": 0.1
},
"weight": 0.1
}
],
"unloadedCartons": [{"cartonId": "string",
"dimensions": {"length": 0.1,
"width": 0.1,
"height": 0.1
},
"weight": 0.1
}
]
},
"firedRules": [{"ruleId": "string",
"ruleName": "string",
"ruleType": "string",
"summary": "string"
}
]
},
"orderMapping": {"property1": ["string"
],
"property2": ["string"
]
},
"groupId": "string",
"groupStatus": "string"
}

Consolidation Profiles

Consolidation profile templates

List consolidation profiles

Authorizations:

ApiKeyAuthBearerAuth

query Parameters

limit	integer [ 1 .. 100 ] Default: 20 Maximum number of items to return
cursor	string Opaque pagination cursor from a previous response's `nextCursor`

Responses

Response samples

200
401

Content type

application/json

{"items": [{"id": "string",
"name": "string",
"description": "string",
"groupingKeys": ["string"
],
"consolidationLevel": "string",
"allowMixedOrdersInCarton": true,
"constraints": { },
"version": 0,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"nextCursor": "string"
}

Create a consolidation profile

Authorizations:

ApiKeyAuthBearerAuth

Request Body schema: application/json
required

name required	string <= 256 characters
description	string <= 2000 characters
groupingKeys required	Array of strings non-empty Fields to group by (e.g. "shipTo.postalCode", "serviceLevel")
consolidationLevel	string Default: "Box" Enum: "Box" "Pallet"
allowMixedOrdersInCarton	boolean Default: false
	object

Responses

Request samples

Payload

Content type

application/json

{"name": "Same-destination consolidation",
"groupingKeys": ["shipTo.postalCode",
"serviceLevel"
],
"consolidationLevel": "Box",
"allowMixedOrdersInCarton": true
}

Response samples

201
401

Content type

application/json

{"id": "string",
"name": "string",
"description": "string",
"groupingKeys": ["string"
],
"consolidationLevel": "string",
"allowMixedOrdersInCarton": true,
"constraints": { },
"version": 0,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}

Get a consolidation profile

Authorizations:

ApiKeyAuthBearerAuth

path Parameters

id

required

string

Responses

Response samples

200
401
404

Content type

application/json

{"id": "string",
"name": "string",
"description": "string",
"groupingKeys": ["string"
],
"consolidationLevel": "string",
"allowMixedOrdersInCarton": true,
"constraints": { },
"version": 0,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}

Update a consolidation profile

Authorizations:

ApiKeyAuthBearerAuth

path Parameters

id

required

string

Request Body schema: application/json
required

name required	string <= 256 characters
description	string <= 2000 characters
groupingKeys required	Array of strings non-empty Fields to group by (e.g. "shipTo.postalCode", "serviceLevel")
consolidationLevel	string Default: "Box" Enum: "Box" "Pallet"
allowMixedOrdersInCarton	boolean Default: false
	object

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"description": "string",
"groupingKeys": ["string"
],
"consolidationLevel": "Box",
"allowMixedOrdersInCarton": false,
"constraints": {"maxWeightPerGroup": 0.1,
"maxItemsPerGroup": 0,
"maxOrdersPerGroup": 0
}
}

Response samples

200
401
404
409

Content type

application/json

{"id": "string",
"name": "string",
"description": "string",
"groupingKeys": ["string"
],
"consolidationLevel": "string",
"allowMixedOrdersInCarton": true,
"constraints": { },
"version": 0,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}

Delete a consolidation profile

Authorizations:

ApiKeyAuthBearerAuth

path Parameters

id

required

string

Responses

Response samples

401
404

Content type

application/problem+json

{"type": "https://developers.fractalpack.com/errors/unauthorized",
"title": "Unauthorized",
"status": 401,
"detail": "Invalid or missing authentication credentials.",
"instance": "0HN9A1B2C3D4:00000002",
"doc_url": "https://developers.fractalpack.com/errors/unauthorized"
}

Wave Planning

Warehouse wave planning and pick optimization

Generate an optimized wave plan

Analyzes orders and warehouse layout to generate optimized pick waves that minimize travel distance using TSP-based routing.

Authorizations:

ApiKeyAuthBearerAuth

Request Body schema: application/json
required

required	Array of objects non-empty
	object

Responses

Request samples

Payload

Content type

application/json

{"orders": [{"orderId": "ORD-001",
"priority": 1,
"items": [{"sku": "WIDGET-001",
"quantity": 3
},
{"sku": "GADGET-002",
"quantity": 1
}
]
}
],
"config": {"maxPicksPerWave": 200,
"maxOrdersPerWave": 50
}
}

Response samples

200
400
401

Content type

application/json

{"warehouseId": "string",
"waves": [{"waveId": "string",
"orders": ["string"
],
"picks": [{"sku": "string",
"location": "string",
"zone": "string",
"quantity": 0
}
],
"zones": ["string"
],
"metrics": {"totalPicks": 0,
"totalDistance": 0.1,
"naiveDistance": 0.1,
"improvementPercent": 0.1,
"estimatedTimeSeconds": 0.1
}
}
],
"summary": {"totalWaves": 0,
"totalOrders": 0,
"totalPicks": 0,
"totalDistance": 0.1,
"totalNaiveDistance": 0.1,
"overallImprovementPercent": 0.1,
"totalEstimatedTimeSeconds": 0.1
}
}

List available wave planning algorithms

Authorizations:

ApiKeyAuthBearerAuth

Responses

Response samples

200
401

Content type

application/json

["nearest-neighbor-2opt",
"nearest-neighbor"
]

Fulfillment Plans

Multi-modal fulfillment strategy evaluation

Create a fulfillment plan

Evaluates parcel vs LTL shipping strategies for the given orders and returns options with cost breakdowns.

Authorizations:

ApiKeyAuthBearerAuth

Request Body schema: application/json
required

orderIds required	Array of strings non-empty
packingConfig	object Packing configuration overrides
parcelCarriers	Array of strings Parcel carrier IDs to rate (defaults to all connected)
ltlCarriers	Array of strings LTL carrier IDs to rate (defaults to all connected)

Responses

Request samples

Payload

Content type

application/json

{"orderIds": ["ord_abc123"
],
"parcelCarriers": ["ups",
"fedex"
]
}

Response samples

201
401
404
422

Content type

application/json

{"id": "string",
"orderIds": ["string"
],
"status": "string",
"options": {"property1": { },
"property2": { }
},
"selectedOptionKey": "string",
"shipmentIds": ["string"
],
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}

List fulfillment plans

Authorizations:

ApiKeyAuthBearerAuth

query Parameters

status	string Filter by plan status
limit	integer [ 1 .. 100 ] Default: 20 Maximum number of items to return
cursor	string Opaque pagination cursor from a previous response's `nextCursor`

Responses

Response samples

200
401

Content type

application/json

{"items": [{"id": "string",
"orderIds": ["string"
],
"status": "string",
"options": {"property1": { },
"property2": { }
},
"selectedOptionKey": "string",
"shipmentIds": ["string"
],
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"nextCursor": "string"
}

Get a fulfillment plan

Authorizations:

ApiKeyAuthBearerAuth

path Parameters

planId

required

string

Responses

Response samples

200
401
404

Content type

application/json

{"id": "string",
"orderIds": ["string"
],
"status": "string",
"options": {"property1": { },
"property2": { }
},
"selectedOptionKey": "string",
"shipmentIds": ["string"
],
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}

Cancel a fulfillment plan

Authorizations:

ApiKeyAuthBearerAuth

path Parameters

planId

required

string

Responses

Response samples

200
401
404

Content type

application/json

{"id": "string",
"orderIds": ["string"
],
"status": "string",
"options": {"property1": { },
"property2": { }
},
"selectedOptionKey": "string",
"shipmentIds": ["string"
],
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}

Select a fulfillment option

Select an option (e.g. "parcel" or "ltl") from a ready plan. This creates the corresponding shipment(s).

Authorizations:

ApiKeyAuthBearerAuth

path Parameters

planId

required

string

Request Body schema: application/json
required

optionKey

required

string

Option key to select (e.g. "parcel", "ltl")

Responses

Request samples

Payload

Content type

application/json

{"optionKey": "parcel"
}

Response samples

200
400
401
404

Content type

application/json

{"id": "string",
"orderIds": ["string"
],
"status": "string",
"options": {"property1": { },
"property2": { }
},
"selectedOptionKey": "string",
"shipmentIds": ["string"
],
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}

Integrations

ERP/host system connectors and webhooks

List configured integrations

Authorizations:

ApiKeyAuthBearerAuth

Responses

Response samples

200
401

Content type

application/json

[{"connectorType": "string",
"displayName": "string",
"enabled": true,
"tenantUrl": "string",
"fieldMappings": {"itemMappings": [{"sourceField": "string",
"targetField": "string",
"transform": "string"
}
],
"deliveryMappings": [{"sourceField": "string",
"targetField": "string",
"transform": "string"
}
]
},
"settings": {"defaultAlgorithm": "string",
"enableCostOptimization": true,
"preferredDimensionUnit": "string",
"preferredWeightUnit": "string",
"webhookSecret": "string"
},
"status": {"lastSyncAt": "2019-08-24T14:15:22Z",
"lastSyncStatus": "string",
"lastSyncItemCount": 0,
"lastError": "string",
"lastWebhookAt": "2019-08-24T14:15:22Z",
"lastWebhookStatus": "string"
},
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
]

List available connector types

Authorizations:

ApiKeyAuthBearerAuth

Responses

Response samples

200
401

Content type

application/json

[{"connectorType": "string",
"displayName": "string",
"description": "string",
"requiredCredentialFields": ["string"
]
}
]

Get integration config for a connector type

Authorizations:

ApiKeyAuthBearerAuth

path Parameters

connectorType

required

string

Example: sap-s4hana

Responses

Response samples

200
401
404

Content type

application/json

{"connectorType": "string",
"displayName": "string",
"enabled": true,
"tenantUrl": "string",
"fieldMappings": {"itemMappings": [{"sourceField": "string",
"targetField": "string",
"transform": "string"
}
],
"deliveryMappings": [{"sourceField": "string",
"targetField": "string",
"transform": "string"
}
]
},
"settings": {"defaultAlgorithm": "string",
"enableCostOptimization": true,
"preferredDimensionUnit": "string",
"preferredWeightUnit": "string",
"webhookSecret": "string"
},
"status": {"lastSyncAt": "2019-08-24T14:15:22Z",
"lastSyncStatus": "string",
"lastSyncItemCount": 0,
"lastError": "string",
"lastWebhookAt": "2019-08-24T14:15:22Z",
"lastWebhookStatus": "string"
},
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}

Create or update an integration

Requires admin role.

Authorizations:

ApiKeyAuthBearerAuth

path Parameters

connectorType

required

string

Request Body schema: application/json
required

tenantUrl	string
enabled	boolean
	object Connector-specific credentials (stored encrypted)
	object (IntegrationSettings)
	object (IntegrationFieldMappings)

Responses

Request samples

Payload

Content type

application/json

{"tenantUrl": "https://my-sap.example.com",
"enabled": true,
"credentials": {"clientId": "sap-client-id",
"clientSecret": "sap-client-secret"
},
"settings": {"defaultAlgorithm": "ebAfit"
}
}

Response samples

200
400
401
403

Content type

application/json

{"connectorType": "string",
"displayName": "string",
"enabled": true,
"tenantUrl": "string",
"fieldMappings": {"itemMappings": [{"sourceField": "string",
"targetField": "string",
"transform": "string"
}
],
"deliveryMappings": [{"sourceField": "string",
"targetField": "string",
"transform": "string"
}
]
},
"settings": {"defaultAlgorithm": "string",
"enableCostOptimization": true,
"preferredDimensionUnit": "string",
"preferredWeightUnit": "string",
"webhookSecret": "string"
},
"status": {"lastSyncAt": "2019-08-24T14:15:22Z",
"lastSyncStatus": "string",
"lastSyncItemCount": 0,
"lastError": "string",
"lastWebhookAt": "2019-08-24T14:15:22Z",
"lastWebhookStatus": "string"
},
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}

Delete an integration

Requires admin role.

Authorizations:

ApiKeyAuthBearerAuth

path Parameters

connectorType

required

string

Responses

Response samples

401
403
404

Content type

application/problem+json

{"type": "https://developers.fractalpack.com/errors/unauthorized",
"title": "Unauthorized",
"status": 401,
"detail": "Invalid or missing authentication credentials.",
"instance": "0HN9A1B2C3D4:00000002",
"doc_url": "https://developers.fractalpack.com/errors/unauthorized"
}

Test integration connectivity

Authorizations:

ApiKeyAuthBearerAuth

path Parameters

connectorType

required

string

Responses

Response samples

200
401

Content type

application/json

{"success": true,
"message": "string",
"latencyMs": 0
}

Trigger a master data sync

Pulls items and/or orders from the connected host system.

Authorizations:

ApiKeyAuthBearerAuth

path Parameters

connectorType

required

string

Responses

Response samples

200
401
404

Content type

application/json

{"success": true,
"itemsSynced": 0,
"itemsSkipped": 0,
"warnings": ["string"
],
"errors": ["string"
]
}

Get last sync status

Authorizations:

ApiKeyAuthBearerAuth

path Parameters

connectorType

required

string

Responses

Response samples

200
401
404

Content type

application/json

{"lastSyncAt": "2019-08-24T14:15:22Z",
"lastSyncStatus": "string",
"lastSyncItemCount": 0,
"lastError": "string"
}

Get field mappings for an integration

Authorizations:

ApiKeyAuthBearerAuth

path Parameters

connectorType

required

string

Responses

Response samples

200
401
404

Content type

application/json

{"itemMappings": [{"sourceField": "string",
"targetField": "string",
"transform": "string"
}
],
"deliveryMappings": [{"sourceField": "string",
"targetField": "string",
"transform": "string"
}
]
}

Update field mappings

Requires admin role.

Authorizations:

ApiKeyAuthBearerAuth

path Parameters

connectorType

required

string

Request Body schema: application/json
required

	Array of objects (FieldMappingRule)
	Array of objects (FieldMappingRule)

Responses

Request samples

Payload

Content type

application/json

{"itemMappings": [{"sourceField": "string",
"targetField": "string",
"transform": "string"
}
],
"deliveryMappings": [{"sourceField": "string",
"targetField": "string",
"transform": "string"
}
]
}

Response samples

200
401
403
404

Content type

application/json

{"itemMappings": [{"sourceField": "string",
"targetField": "string",
"transform": "string"
}
],
"deliveryMappings": [{"sourceField": "string",
"targetField": "string",
"transform": "string"
}
]
}

Reset field mappings to defaults

Requires admin role.

Authorizations:

ApiKeyAuthBearerAuth

path Parameters

connectorType

required

string

Responses

Response samples

200
401
403
404

Content type

application/json

{"itemMappings": [{"sourceField": "string",
"targetField": "string",
"transform": "string"
}
],
"deliveryMappings": [{"sourceField": "string",
"targetField": "string",
"transform": "string"
}
]
}

Get default field mapping template

Authorizations:

ApiKeyAuthBearerAuth

path Parameters

connectorType

required

string

Responses

Response samples

200
400
401

Content type

application/json

{"itemMappings": [{"sourceField": "string",
"targetField": "string",
"transform": "string"
}
],
"deliveryMappings": [{"sourceField": "string",
"targetField": "string",
"transform": "string"
}
]
}

Receive a webhook from a host system

Unauthenticated endpoint for receiving push notifications from connected host systems. Validated via HMAC signature in the X-Webhook-Signature header.

path Parameters

connectorType required	string
orgId required	string

header Parameters

X-Webhook-Signature

string

HMAC-SHA256 signature of the request body

Request Body schema: application/json
required

object

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

200
400
401
404

Content type

application/json

{"success": true,
"itemsSynced": 0,
"itemsSkipped": 0,
"warnings": ["string"
],
"errors": ["string"
]
}

Identity

Current user and algorithm information

Get the current authenticated user

Authorizations:

ApiKeyAuthBearerAuth

Responses

Response samples

200
401

Content type

application/json

{"email": "user@example.com",
"orgId": "org_abc123",
"isAdmin": false
}

List available packing algorithms

Public endpoint (no authentication required).

Responses

Response samples

200

Content type

application/json

{"algorithms": [{"name": "ebAfit",
"displayName": "EB-AFIT"
},
{"name": "liquidFill",
"displayName": "Liquid Fill"
},
{"name": "fpFast",
"displayName": "FP Fast"
}
],
"defaultAlgorithm": "ebAfit"
}

API Keys

API key management

Create an API key

Authorizations:

ApiKeyAuthBearerAuth

Request Body schema: application/json
required

label	string <= 256 characters Human-readable label for the key
expiresInDays	integer Expiration in days (null = no expiration)

Responses

Request samples

Payload

Content type

application/json

{"label": "Production integration",
"expiresInDays": 365
}

Response samples

200
401

Content type

application/json

{"keyId": "key_abc123",
"label": "Production integration",
"apiKey": "fpk_live_abc123def456...",
"keyPrefix": "fpk_live_abc",
"isActive": true,
"createdAt": "2026-04-01T00:00:00Z",
"expiresAt": "2027-04-01T00:00:00Z",
"mode": "live"
}

List API keys

Returns all API keys for the organization. The full key value is never returned after creation, only the prefix.

Authorizations:

ApiKeyAuthBearerAuth

Responses

Response samples

200
401

Content type

application/json

[{"keyId": "string",
"label": "string",
"apiKey": "string",
"keyPrefix": "string",
"isActive": true,
"createdAt": "2019-08-24T14:15:22Z",
"expiresAt": "2019-08-24T14:15:22Z",
"mode": "test"
}
]

Revoke an API key

Authorizations:

ApiKeyAuthBearerAuth

path Parameters

keyId

required

string

Responses

Response samples

401

Content type

application/problem+json

{"type": "https://developers.fractalpack.com/errors/unauthorized",
"title": "Unauthorized",
"status": 401,
"detail": "Invalid or missing authentication credentials.",
"instance": "0HN9A1B2C3D4:00000002",
"doc_url": "https://developers.fractalpack.com/errors/unauthorized"
}

Users

Organization user management. Requires the admin role within your organization.

List users

Requires admin role.

Authorizations:

ApiKeyAuthBearerAuth

Responses

Response samples

200
401
403

Content type

application/json

[{"username": "string",
"email": "string",
"nickname": "string",
"status": "string",
"enabled": true,
"isAdmin": true,
"createdAt": "2019-08-24T14:15:22Z"
}
]

Create a user

Requires admin role.

Authorizations:

ApiKeyAuthBearerAuth

Request Body schema: application/json
required

email required	string <email> <= 256 characters
temporaryPassword required	string [ 1 .. 256 ] characters
isAdmin	boolean Default: false

Responses

Request samples

Payload

Content type

application/json

{"email": "newuser@example.com",
"temporaryPassword": "TempPass123!",
"isAdmin": false
}

Response samples

200
400
401
403
409

Content type

application/json

{"username": "string",
"email": "string",
"nickname": "string",
"status": "string",
"enabled": true,
"isAdmin": true,
"createdAt": "2019-08-24T14:15:22Z"
}

Get a user

Requires admin role.

Authorizations:

ApiKeyAuthBearerAuth

path Parameters

username

required

string

Responses

Response samples

200
401
403
404

Content type

application/json

{"username": "string",
"email": "string",
"nickname": "string",
"status": "string",
"enabled": true,
"isAdmin": true,
"createdAt": "2019-08-24T14:15:22Z"
}

Update a user

Requires admin role.

Authorizations:

ApiKeyAuthBearerAuth

path Parameters

username

required

string

Request Body schema: application/json
required

nickname	string <= 256 characters
isAdmin	boolean

Responses

Request samples

Payload

Content type

application/json

{"nickname": "John",
"isAdmin": true
}

Response samples

200
401
403
404

Content type

application/json

{"username": "string",
"email": "string",
"nickname": "string",
"status": "string",
"enabled": true,
"isAdmin": true,
"createdAt": "2019-08-24T14:15:22Z"
}

Delete a user

Requires admin role.

Authorizations:

ApiKeyAuthBearerAuth

path Parameters

username

required

string

Responses

Response samples

401
403
404

Content type

application/problem+json

{"type": "https://developers.fractalpack.com/errors/unauthorized",
"title": "Unauthorized",
"status": 401,
"detail": "Invalid or missing authentication credentials.",
"instance": "0HN9A1B2C3D4:00000002",
"doc_url": "https://developers.fractalpack.com/errors/unauthorized"
}

Disable a user

Requires admin role.

Authorizations:

ApiKeyAuthBearerAuth

path Parameters

username

required

string

Responses

Response samples

401
403
404

Content type

application/problem+json

{"type": "https://developers.fractalpack.com/errors/unauthorized",
"title": "Unauthorized",
"status": 401,
"detail": "Invalid or missing authentication credentials.",
"instance": "0HN9A1B2C3D4:00000002",
"doc_url": "https://developers.fractalpack.com/errors/unauthorized"
}

Enable a user

Requires admin role.

Authorizations:

ApiKeyAuthBearerAuth

path Parameters

username

required

string

Responses

Response samples

401
403
404

Content type

application/problem+json

{"type": "https://developers.fractalpack.com/errors/unauthorized",
"title": "Unauthorized",
"status": 401,
"detail": "Invalid or missing authentication credentials.",
"instance": "0HN9A1B2C3D4:00000002",
"doc_url": "https://developers.fractalpack.com/errors/unauthorized"
}

Reset a user's password

Sends a password reset email. Requires admin role.

Authorizations:

ApiKeyAuthBearerAuth

path Parameters

username

required

string

Responses

Response samples

401
403
404

Content type

application/problem+json

{"type": "https://developers.fractalpack.com/errors/unauthorized",
"title": "Unauthorized",
"status": 401,
"detail": "Invalid or missing authentication credentials.",
"instance": "0HN9A1B2C3D4:00000002",
"doc_url": "https://developers.fractalpack.com/errors/unauthorized"
}

Usage

Usage statistics

Get usage statistics

Authorizations:

ApiKeyAuthBearerAuth

query Parameters

days	integer Default: 30 Number of days to include

Responses

Response samples

200
401

Content type

application/json

{"totalRequests": 12450,
"totalItemsPacked": 89300,
"totalContainersUsed": 4200,
"dailyBreakdown": [{"date": "2026-04-02",
"requests": 450,
"itemsPacked": 3200,
"containersUsed": 150,
"byCategory": {"pack": 400,
"batch": 50
}
}
]
}

Entitlements

Organization entitlements and limits

Get organization entitlements

Authorizations:

ApiKeyAuthBearerAuth

Responses

Response samples

200
401

Content type

application/json

{"enabledProducts": ["packing",
"shipping",
"consolidation"
],
"maxUsers": 25,
"rateLimits": {"pack": 100,
"batch": 10
},
"monthlyRequestQuota": 100000
}

FractalPack Packing API (1.0.0)

Pagination

Rate Limiting

Errors

Packing

Pack items into containers

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Batch

Submit a batch of packing jobs

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

List batches

Authorizations:

query Parameters

Responses

Response samples

Get batch status and results

Authorizations:

path Parameters

query Parameters

Responses

Response samples

Items

Create an item

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

List items

Authorizations:

query Parameters

Responses

Response samples

Get an item by ID

Authorizations:

path Parameters

Responses

Response samples

Partially update an item

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Delete an item

Authorizations:

path Parameters

Responses

Response samples

Bulk import items

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Import items from CSV

Authorizations:

Request Body schema: multipart/form-datarequired

Responses

Response samples

Look up an item by external ID

Authorizations:

query Parameters

Responses

Response samples

Get multiple items by ID

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: multipart/form-data
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: multipart/form-data
required

Request Body schema: application/json
required

Request Body schema: application/json
required