POST /api/case-design

Explore product factorisations into shipcases, TI-HI, pallet/container fill and delivered cost per unit. Anonymous: 10/minute, 100/day; JSON body ≤32 KB. Optional X-API-Key or Authorization. GET returns a runnable example.

Request: units cm-kg or in-lb; product {l,w,h,weight,keepUpright?,label?}; unitsPerCase integer or {min,max}; optional caseConstraints {maxWeight,maxDim,boardThickness,headspace,allowedOrientations:any|upright}, pallet {l,w,baseHeight,maxHeight,maxWeight,overhang?}, container {preset:20gp|40gp|40hq} or custom l,w,h,maxWeight; costs {boardCostPerM2,freightPerContainer,freightPerPallet,handlingPerCase,currency}; candidates 1–10 (default 5).

Response: found or none_within_search; candidates with arrangement, caseOuter (each axis cm/in), caseWeight (kg/lb), pallet, container, optional costPerUnit breakdown, checks and assumptions. Top level includes checks, CHECK_SEMANTICS, engineVersion, SHA-256 inputHash, notes, searched counts and limits. No costs: units/container descending then pallet fill; costs: lowest supplied cost/unit first. Missing costs are zero; pallet and container freight are additive. No destination is allowed for case-only screening.

Search: up to 24 evenly sampled quantities including endpoints, 400 deduplicated outer dimensions (0.1 cm key), 2,000 floor-loaded cases. Product counts 1–2,000. Cases stay upright in transit; column stacks only; pallet container loads use at most two tiers and assume 25 kg pallet tare. Board area ×0.6 kg/m² is an estimate, with 0.4 cm board per side and 0.5 cm headspace defaults. Not ECT/BCT certification or an optimality proof. Infeasible candidates are rejected; no feasible result returns explicit not_evaluated checks. Errors: 400 with field for validation, 413 oversized body, 415 media type, 429 rate limit.

curl https://www.dimpack3d.com/api/case-design
curl https://www.dimpack3d.com/api/case-design -H 'Content-Type: application/json' --data-binary @case-design-request.json

Order options — avoid another pallet

POST /api/order-options accepts the order-quote request plus the fields below. It searches unchanged quantities first using three strategies and four item orderings, then permitted single-SKU changes and pairs only if repacking found nothing. Returns up to three complete alternatives ranked by pallet count, absolute units changed, then net savings. All envelope, stacking, packaging and receiver limits stay unchanged.

• targetPalletCount: integer 1–20; defaults to baseline count minus one, at least one. A goal: smaller improvements and additions without another pallet may still be returned.
• adjustments[]: {sku,minQty,maxQty,qtyStep?}: all SKUs locked by default. Unique existing SKU; bounds 0–200 must include current quantity; step defaults to 1, anchored at current quantity. Zero defers the entire SKU; empty shipments are excluded.
• searchBudget: integer 1–200, default 60; baseline excluded. SEARCH_BUDGET warns when exhausted. Best option found, not a proof of optimality.
• economics: optional palletFreight, handlingPerPallet, contributionPerUnit and deferralCostPerUnit maps by SKU, currency (three uppercase letters). Non-negative customer-supplied costs only. Net = freight saved + handling saved − deferred contribution − deferral cost. Added contribution is a negative deferred contribution. Missing required costs return netSavings:null; enter explicit zero for no cost.

Response: baseline{palletCount,quote}, target, searched{candidates,budget,phase1,phase2}, alternatives[]{id,palletCount,strategy,packing,quantityChanges,quote,candidateHash,economics}, outcome found|none_within_search|already_at_target, checks, semantics, notes, engineVersion, inputHash, tier and warning for invalid keys. Complete nested quotes include both cm/in and kg/lb. quoteOrder also accepts actuals.summary{actualPalletCount,selectedOptionId,measuredAt} and echoes it in variance.summary; measuredAt is an ISO timestamp. To reproduce a selected build, send its packing selection with the changed order-quote request.

Anonymous: 5/min, 50/day. JSON body ≤48 KB. GET returns an example; OPTIONS supports CORS with X-API-Key and Authorization. Errors: 400 with field for validation, 413 oversized body, 415 wrong content type, 429 rate limit. Checks are screening, not certification.

curl -s https://www.dimpack3d.com/api/order-options > order-options-help.json
curl -X POST https://www.dimpack3d.com/api/order-options -H 'Content-Type: application/json' --data-binary @order-options-request.json

Order → pallet quote API

POST /api/order-quote is the quoting-workflow wrapper over order-plan: explicit units (cm-kg or in-lb), stable sku ids, gross weight incl. pallet tare and packaging allowance, receiver/carrier limit checks with stated assumptions, inputHash + engineVersion, and a meter id (one distinct order). Interactive version with CSV import and predicted-vs-measured tracking: /order-quote

status

complete — every carton placed and every supplied limit passed. partial — not all cartons fit within maxPallets; never quote it as a whole shipment. needs_review — placed, but a supplied limit (limits.maxLoadedHeight / maxGrossWeight) failed; reviewReasons[] says which.

pallets[].outerDims / grossWeight / checks[]

Outer height = base + cargo + packagingAllowance.height; gross = cargo + pallet.tareWeight + packagingAllowance.weight. Both unit systems are returned. Every check carries code, status (pass|fail|warn|not_evaluated), observed, limit and the assumption used — an empty or not_evaluated check is never a pass.

inputHash / engineVersion / meter

SHA-256 of the canonical cm/kg planning input (unit system does not change it; actuals do not either). Same hash + same engineVersion = same result. meter.unit is "order" and meter.id is your orderId (or the hash prefix) — the billable unit on paid plans.

actuals

Optional { "0": { height, grossWeight, note } } keyed by pallet index, in request units; returns variance per pallet (delta, deltaPct). This is how the pilot measures us.

Limits

20 carton types, 200 cartons, 20 pallets, 32 KB body per order. Anonymous 10/min, 100/day per IP; free key 5×. GET the endpoint for a full example request.

curl -s https://www.dimpack3d.com/api/order-quote | jq .request > order-quote-request.json
curl -X POST https://www.dimpack3d.com/api/order-quote \
  -H "Content-Type: application/json" -H "X-API-Key: dp_live_…" \
  --data-binary @order-quote-request.json | jq '{status, reviewReasons, summary, pallets: [.pallets[] | {outerDims, grossWeight, checks: [.checks[] | {code, status}]}]}'

Estimate a pallet’s loaded height

POST /api/pallet-estimate compares three packing approaches and returns the best plan found. Height includes the pallet base. A partial result describes only the cartons placed, not the whole order. Minimum height is not proven.

Legacy synchronous cm/kg-only API: supplying a units field in the pallet request is rejected. Responses use version, without engineVersion or inputHash. Use /api/order-quote for unit conversion and SHA-256 identity.

{
  "pallet": {
    "l": 120,
    "w": 80,
    "baseHeight": 15,
    "maxHeight": 160,
    "maxWeight": 750
  },
  "items": [
    {
      "label": "Main cartons",
      "l": 60,
      "w": 40,
      "h": 30,
      "qty": 12,
      "weight": 8,
      "keepUpright": true
    },
    {
      "label": "Small cartons",
      "l": 40,
      "w": 30,
      "h": 20,
      "qty": 8,
      "weight": 4,
      "keepUpright": true
    }
  ]
}

pallet

l/w: footprint; baseHeight: empty pallet height; maxHeight: total height cap including base; maxWeight: cargo-only payload. All cm/kg. Limits must be supplied.

items[]

label, l/w/h, integer qty, positive weight and boolean keepUpright are required. Optional maxStack is the allowed kg on top; 0 prevents stacking. Missing maxStack leaves carton strength unchecked.

status / loadedHeight / byItem / boxes

complete means all cartons placed; partial means some remain. loadedHeight includes baseHeight. byItem lists requested, placed and remaining counts. boxes uses px/py/pz min-corner positions, with py measured above the pallet deck. cargoWeight excludes pallet tare.

Limits and errors

20 types / 200 cartons / 32 KB per request. Free beta: 20/min and 200/day per IP when rate-limit storage is configured. HTTP 400: invalid JSON or fields; 413: body too large; 415: wrong content type; 429: rate limit (Retry-After header). Larger production orders: contact us.