Inventory & orders API — SmartCut API Reference

Version Ecommerce

Store endpoints for managing inventory and tracking order progress.

## Inventory

Inventory is a two-level hierarchy. A material is a product line ("18mm Oak MFC") identified by a code that is unique within your store. A stock item is one cuttable sheet or length beneath it, carrying its own dimensions and quantity.

Stock is addressed under its material — POST /ecommerce/api/materials/{id}/stock — so the parent link comes from the URL and is never something you send.

Inheritance: stock inherits cost, grain, category, extras and the other shared fields from its material, so you only set what differs. Reads always return the effective values. Setting an inherited field on a stock item pins it, and it will no longer follow later edits to the material; set it to null to resume inheriting.

Quantities: use POST /ecommerce/api/stock/{id}/adjust with a relative delta rather than PATCH-ing q. The adjust endpoint is atomic, so concurrent callers cannot oversell, and it never deletes a row that reaches zero.

## Order workflow

Order status progression: pending → cut → complete → dispatched

Part tracking: Each basket item contains an array of input parts. Use numberCut to track how many of each part type have been cut, and numberComplete to track how many have been fully completed. Parts are identified by partIndex (their position in the basket item's parts array).

## Errors

Validation failures return 400 with a machine-readable code and an errors array naming each offending field. Unrecognised fields are rejected rather than ignored, so a misspelled key is never silently dropped.

Authentication: All endpoints require an API key and an active ecommerce subscription.

Endpoints

Machine-readable specification: /openapi/ecommerce.json. Authentication is the raw API key in the Authorization header, with no Bearer prefix.