Deletes the unit of measure group with the given identifier.

DELETE /inventory/unit-of-measure-groups/{id}

Group: Inventory › Unit of Measure Groups · Operation ID: deleteUnitOfMeasureGroup

A unit of measure group must be empty before it can be deleted: no items may point at it, and it must have no conversion lines, the base unit's line included. Reassign any items and remove the lines with deleteLines on PATCH inventory/unit-of-measure-groups/:id first. This is a hard delete. Use POST inventory/unit-of-measure-groups/bulk-delete to delete several at once.

Open in the interactive reference

Parameters

Name In Type Required Description
Api-Version header "v1" yes The API version this request targets, named by its public identifier. Required on every request; omitting it, or naming a version this company does not have, is answered with 400. This document describes version v1.
Idempotency-Key header string no An opaque caller-chosen string (1-255 characters) that makes this request safe to retry. Repeating the same key with an identical request body replays the original response instead of re-executing - but only once that original request succeeded; a failed attempt re-executes on retry. Repeating the key with a different body is answered with 422. A key still in flight is answered with 409 - as is a key whose original request was interrupted before it finished, for a few minutes afterwards, until that attempt is presumed dead. A completed response stays replayable for 24 hours. The key is scoped to the caller, not to the action: reusing it for a different action is answered with 409 or 422 rather than treated independently. On read actions this header is ignored. On write actions that cannot offer the guarantee it is answered with 400 IDEMPOTENCY_NOT_SUPPORTED rather than silently ignored.
id path string yes The unique identifier for the unit of measure group to delete.

Response

200 Success

Under data (deleteUnitOfMeasureGroupOutput):

Field Type Required Description
id string yes The unique identifier for the deleted unit of measure group.
name string yes The display name the deleted unit of measure group held.

Response headers

Errors

Code Status
NOT_FOUND 400
UNIT_OF_MEASURE_GROUP_IN_USE 400
IDEMPOTENCY_KEY_CONFLICT 409
IDEMPOTENCY_PAYLOAD_MISMATCH 422

Statuses