# Create a unit of measure group

Operation ID: `createUnitOfMeasureGroup`

Group: Inventory › Unit of Measure Groups

[Open in the interactive reference](https://docs.api.lensing.ai/lensing/v1/endpoints/createUnitOfMeasureGroup)

`POST /inventory/unit-of-measure-groups`

Retry-safe: A write that accepts Idempotency-Key: repeating a request with the same key replays the stored answer instead of executing twice.

Creates a unit of measure group. A group has a base unit and conversion lines. The base unit gets its own line automatically, with a factor of 1. Send the base unit as baseUnitOfMeasureId and leave it out of lines.

The response contains only the group's id. To see the group with the ids assigned to its lines, use GET inventory/unit-of-measure-groups/:id. To create several groups at once, use POST inventory/unit-of-measure-groups/bulk.

## Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `Api-Version` | header | string · 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. |

## Request body

Required, `application/json`: createUnitOfMeasureGroupInput.

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `name` | string | yes | The display name of the unit of measure group. Required. It is not checked for uniqueness. Example: `"Packaging"`. |
| `description` | string | no | A free-form description of what the group covers. Omit for none. Example: `"Eaches, boxes and pallets"`. |
| `baseUnitOfMeasureId` | string | yes | The unique identifier for the base unit of measure that every conversion factor in the group is relative to. Required. It is fixed for the life of the group and gets its own line automatically with a factor of 1, so do not list it in lines. See id on GET inventory/unit-of-measures/:id. Example: `"3b7d5e9c-1a24-4f80-9c6d-2e8f70b13a45"`. |
| `lines` | array<object> | no | The conversion lines to add, beyond the base unit's automatic one. Omit for a group with only its base unit. Each unit of measure may appear at most once, and none may be the base unit. Example: `[{"unitOfMeasureId":"8c1f4a72-6b09-4d15-a3e7-40d2b6915cf8","conversionFactor":"12.00"}]`. |
| `lines[].unitOfMeasureId` | string | yes | The unique identifier for the unit of measure this line converts. It must not be the base unit and must not repeat another line in this request. See id on GET inventory/unit-of-measures/:id. |
| `lines[].conversionFactor` | decimal | yes | How many base units of measure make up one of this unit. It must be greater than zero. |

```json
{
  "name": "Packaging",
  "description": "Eaches, boxes and pallets",
  "baseUnitOfMeasureId": "3b7d5e9c-1a24-4f80-9c6d-2e8f70b13a45",
  "lines": [
    {
      "unitOfMeasureId": "8c1f4a72-6b09-4d15-a3e7-40d2b6915cf8",
      "conversionFactor": "12.00"
    }
  ]
}
```

## Response

`200` Success

Under `data` (createUnitOfMeasureGroupOutput):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | string | yes | The unique identifier for the created unit of measure group. Example: `"2c7e5a91-6d38-4b04-8f72-1e9c03d5b846"`. |

```json
{
  "data": {
    "id": "2c7e5a91-6d38-4b04-8f72-1e9c03d5b846"
  },
  "diagnostics": [
    {
      "code": "UNIT_OF_MEASURE_GROUP_CREATED",
      "message": "<message>",
      "severity": "error",
      "path": [
        "<path>"
      ],
      "details": {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
      }
    }
  ]
}
```

## Response headers

- `Idempotency-Replayed` — Present and `true` only when this response replays a previously stored one for the same Idempotency-Key, rather than reflecting a live execution. Absent on a live response - never sent as `false`.

## Errors

| Code | Status |
| --- | --- |
| `UNIT_NOT_FOUND` | 400 |
| `DUPLICATE_UNIT_IN_GROUP` | 400 |
| `INVALID_CONVERSION_FACTOR` | 400 |
| `IDEMPOTENCY_KEY_CONFLICT` | 409 |
| `IDEMPOTENCY_PAYLOAD_MISMATCH` | 422 |

## Advisories

Warnings and information a successful response can carry under `diagnostics`:

- `UNIT_OF_MEASURE_GROUP_CREATED`

## Statuses

- `400` — Invalid request or business failure. Codes: UNIT_NOT_FOUND, DUPLICATE_UNIT_IN_GROUP, INVALID_CONVERSION_FACTOR
- `401` — The request carries no valid access token.
- `403` — Not authorized
- `404` — Not found
- `409` — The Idempotency-Key is still being processed by another request.
- `422` — The Idempotency-Key was already used with a different request payload.
- `429` — Too many requests from this client address. The response has no body and no `Retry-After` header.
- `500` — Internal server error