Bulk create units of measure

Operation ID: bulkCreateUnitOfMeasures

Group: Inventory › Units of Measure

Open in the interactive reference

POST /inventory/unit-of-measures/bulk

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

Creates multiple units of measure in one request. Each unit of measure in the request takes the same fields as the body of POST inventory/unit-of-measures.

If any unit of measure can't be created, none are, and the error gives its position in the request.

The response lists the created units of measure in the order you sent them, each with only its id. To create a single unit of measure, use POST inventory/unit-of-measures.

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: bulkCreateUnitOfMeasuresInput.

Field Type Required Description
unitOfMeasures array<object> yes The units of measure to create. If any entry is invalid, nothing is written and the whole call fails. Example: [{"unitCode":"KG","unitName":"Kilogram"},{"unitCode":"G","unitName":"Gram"}].
unitOfMeasures[].unitCode string yes The short code of the unit of measure, for example 'KG'. Required. It must be unique within the tenant and within this request.
unitOfMeasures[].unitName string yes The display name of the unit of measure, for example 'Kilogram'. 
{
  "unitOfMeasures": [
    {
      "unitCode": "KG",
      "unitName": "Kilogram"
    },
    {
      "unitCode": "G",
      "unitName": "Gram"
    }
  ]
}

Response

200 Success

Under data (bulkCreateUnitOfMeasuresOutput):

Field Type Required Description
created array<object> yes The created units of measure, in the same order as the input. Match entries to inputs by index. Read a record with GET inventory/unit-of-measures/:id when you need its stored state. Example: [{"id":"3b7d5e9c-1a24-4f80-9c6d-2e8f70b13a45"},{"id":"8c1f4a72-6b09-4d15-a3e7-40d2b6915cf8"}].
created[].id string yes The unique identifier for the created unit of measure. 
{
  "data": {
    "created": [
      {
        "id": "3b7d5e9c-1a24-4f80-9c6d-2e8f70b13a45"
      },
      {
        "id": "8c1f4a72-6b09-4d15-a3e7-40d2b6915cf8"
      }
    ]
  },
  "diagnostics": [
    {
      "code": "<code>",
      "message": "<message>",
      "severity": "error",
      "path": [
        "<path>"
      ],
      "details": "<details>"
    }
  ]
}

Response headers

Errors

Code Status
DUPLICATE_UNIT_CODE 400
DUPLICATE_UNIT_CODE_IN_REQUEST 400
IDEMPOTENCY_KEY_CONFLICT 409
IDEMPOTENCY_PAYLOAD_MISMATCH 422

Statuses