Bulk create unit of measure groups

Operation ID: bulkCreateUnitOfMeasureGroups

Group: Inventory › Unit of Measure Groups

Open in the interactive reference

POST /inventory/unit-of-measure-groups/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 unit of measure groups in one request. Each group in the request takes the same fields as the body of POST inventory/unit-of-measure-groups, including its conversion lines.

If any group can't be created, none are, and the error gives that group's position in the request.

The response lists the created groups in the order you sent them, each with only its id. To see the ids assigned to their lines, use GET inventory/unit-of-measure-groups/:id.

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

Field Type Required Description
unitOfMeasureGroups array<object> yes The unit of measure groups to create, each with its own conversion lines. If any entry is invalid, nothing is created and the whole call fails. Example: [{"name":"Packaging","baseUnitOfMeasureId":"3b7d5e9c-1a24-4f80-9c6d-2e8f70b13a45","lines":[{"unitOfMeasureId":"8c1f4a72-6b09-4d15-a3e7-40d2b6915cf8","conversionFactor":"12.00"}]},{"name":"Weight","baseUnitOfMeasureId":"e57a0d34-9f62-4b18-bc25-71a6e8039d4b"}].
unitOfMeasureGroups[].name string yes The display name of the unit of measure group. Required. It is not checked for uniqueness.
unitOfMeasureGroups[].description string no A free-form description of what the group covers. Omit for none.
unitOfMeasureGroups[].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.
unitOfMeasureGroups[].lines array<object> no The conversion lines for this group, beyond the base unit's automatic one. Each unit of measure may appear at most once within this entry.
unitOfMeasureGroups[].lines[].unitOfMeasureId string yes The unique identifier for the unit of measure this line converts. See id on GET inventory/unit-of-measures/:id.
unitOfMeasureGroups[].lines[].conversionFactor decimal yes How many base units of measure make up one of this unit. It must be greater than zero. 
{
  "unitOfMeasureGroups": [
    {
      "name": "Packaging",
      "baseUnitOfMeasureId": "3b7d5e9c-1a24-4f80-9c6d-2e8f70b13a45",
      "lines": [
        {
          "unitOfMeasureId": "8c1f4a72-6b09-4d15-a3e7-40d2b6915cf8",
          "conversionFactor": "12.00"
        }
      ]
    },
    {
      "name": "Weight",
      "baseUnitOfMeasureId": "e57a0d34-9f62-4b18-bc25-71a6e8039d4b"
    }
  ]
}

Response

200 Success

Under data (bulkCreateUnitOfMeasureGroupsOutput):

Field Type Required Description
created array<object> yes The created unit of measure groups, in the same order as the input. Match entries to inputs by index. Read a group with GET inventory/unit-of-measure-groups/:id to learn the ids assigned to its lines. Example: [{"id":"2c7e5a91-6d38-4b04-8f72-1e9c03d5b846"},{"id":"5a8b0c34-7e19-4f26-9d51-b0c6238ea7f4"}].
created[].id string yes The unique identifier for the created unit of measure group. 
{
  "data": {
    "created": [
      {
        "id": "2c7e5a91-6d38-4b04-8f72-1e9c03d5b846"
      },
      {
        "id": "5a8b0c34-7e19-4f26-9d51-b0c6238ea7f4"
      }
    ]
  },
  "diagnostics": [
    {
      "code": "<code>",
      "message": "<message>",
      "severity": "error",
      "path": [
        "<path>"
      ],
      "details": "<details>"
    }
  ]
}

Response headers

Errors

Code Status
UNIT_NOT_FOUND 400
DUPLICATE_UNIT_IN_GROUP 400
INVALID_CONVERSION_FACTOR 400
IDEMPOTENCY_KEY_CONFLICT 409
IDEMPOTENCY_PAYLOAD_MISMATCH 422

Statuses