Preview

Preview: this operation may change or be removed without a new versioned route or notice period until it is announced as stable (see the API Versioning Policy). Returns all identifiers issued for the item, newest first, including superseded ones (isCurrent=false). Each identifier carries inventoryActive, which is false while the item is soft-deleted. An item with no identifiers returns an empty array.

Preview: this operation may change or be removed without a new versioned route or notice period until it is announced as stable (see the API Versioning Policy). Idempotent: if the item already has a current identifier of the requested type it is returned unchanged (200). Otherwise a new identifier is minted from the company's namespace (201) — a GS1 key (GTIN+serial, GIAI or SSCC) when the company has a GS1 Company Prefix, an internal GSM- code otherwise. Set reissue=true to explicitly supersede the current identifier. With no identifierType, the type of the item's most recent current identifier is used, for a reprint (that identifier is returned) and for a reissue (it is replaced by a new one of the same type); an item with no current identifier gets the default type: GTIN (a serialised GTIN, SGTIN) with a GS1 Company Prefix, INTERNAL without. A GTIN identifier needs a gtin for the item's first GTIN label (400 if missing, including when GTIN is the default); after that gtin may be omitted to reuse the item's existing GTIN, and a supplied gtin must match it (409). Issuing for a soft-deleted item returns 404.

Preview: this operation may change or be removed without a new versioned route or notice period until it is announced as stable (see the API Versioning Policy). Accepts a GS1 element string in bracketed form, e.g. (01)09501101530003(21)42, or raw scanner form (GS-separated, optional ]Q3 symbology prefix), or an internal GSM- code. Resolves by identity key (SSCC, GIAI, or GTIN+serial); a stale batch/lot (AI 10) still resolves. Superseded identifiers and labels of hard-deleted items (inventoryId=null) are returned with isCurrent=false. A soft-deleted item's label keeps isCurrent=true (its identifier chain is unchanged) and is flagged with inventoryActive=false. Percent-encode the payload; a literal '+' is kept as '+' (not decoded to a space).

Returns all active required/preferred inventory-tag requirements for the company's order line items.

Returns the active required/preferred inventory-tag requirements of the specified order line item. Empty when the line item has none (or does not exist for the company).

Replaces the required and preferred inventory-tag requirements of an order line item with the provided sets. Both lists must be supplied; pass empty lists to clear. A tag cannot be both required and preferred, and every tag must be an active inventory tag of the company.

Preview: this operation may change or be removed without a new versioned route or notice period until it is announced as stable (see the API Versioning Policy). Lists optimisation runs for the specified company, most recent first, paged.

Preview: this operation may change or be removed without a new versioned route or notice period until it is announced as stable (see the API Versioning Policy). Uploads a problem payload as a claim-check blob and dispatches it to the optimisation solver. With PreviewId, dispatches exactly that preview's saved snapshot (Filters/SolverSettings are recorded but not re-applied); otherwise composes a fresh problem from the supplied filters.

Preview: this operation may change or be removed without a new versioned route or notice period until it is announced as stable (see the API Versioning Policy). Composes the problem an optimisation run would dispatch for the supplied filters, saves it as a short-lived preview snapshot, and returns a per-group summary with per-order detail plus the snapshot's PreviewId. Nothing is persisted to the database or dispatched; pass PreviewId to StartOptimisationRun (within 30 minutes) to dispatch exactly this composition. ExcludedGroupKeys is ignored — every composed group is returned.

Preview: this operation may change or be removed without a new versioned route or notice period until it is announced as stable (see the API Versioning Policy). Retrieves a single optimisation run — the polling target while a run is pending.

Preview: this operation may change or be removed without a new versioned route or notice period until it is announced as stable (see the API Versioning Policy). Marks a run as cancelled. Rejected with 400 if the run has already reached a terminal or later status (ResultReceived/SolveFailed/Failed/PlanCreated).

Preview: this operation may change or be removed without a new versioned route or notice period until it is announced as stable (see the API Versioning Policy). Returns an Approved plan to Draft and, in the same transaction, releases the stock reservations the plan's approval created (same release rules as discard). Bars go back to Proposed (Excluded bars stay Excluded), conflicts are cleared and cut review decisions are kept, so the plan can be reviewed and approved again. Only allowed before any bar has started; rejected with 400 otherwise.

Preview: this operation may change or be removed without a new versioned route or notice period until it is announced as stable (see the API Versioning Policy). Returns six booleans derived from the company's real data: millCertUploaded, inventoryCreated, orderWithLineItemCreated, stockReserved, certificatePackGenerated and hexUsed. Soft-deleted records do not count. Also returns activation timing: companyCreatedAt, firstPackAt and timeToFirstPackSeconds (null until the first certificate pack exists).

Preview: this endpoint may change or be removed without notice. Returns company-level settings that are not part of the company profile: currently kerfMm, the saw-blade width lost per cut that the optimiser applies.

Preview: this endpoint may change or be removed without notice. Company admins only. Sets kerfMm, the saw-blade width lost per cut (0 to 20 mm, rounded to 2 decimal places), which the next optimisation run applies. Does not change any other company field.