Create Unit Group

Beta

POST/v1/catalog/unit-groups

Idempotent with Idempotency-Key header. Learn more

Creates a unit group with optional associated units.

include[]optional arrayenumValues:ownerowner.accountbase_unit

Sub-objects to expand in the response. When omitted, sub-objects are returned as null.

namestring

Display name.

notesoptional string

Notes. Defaults to null.

typestringenumValues:currencyquantitytime

Unit type.

base_unit_idstring

Base unit ID.

associated_unitsarray of object

Associated units to create with the group.

unit_idstring

Unit ID.

discount_percentageoptional number

Discount percentage. Defaults to 1.

discount_fixedoptional number

Fixed discount amount. Defaults to 0.

customer_portal_visibilityoptional stringenumValues:visiblehidden

Customer portal visibility. Defaults to visible.

idstring

Unit group ID.

objectstringenumValues:unit_group

Resource type identifier.

namestring

Display name.

notesstringnullable

Notes.

typestringenumValues:currencyquantitytime

Unit type.

base_unitobjectExpandablenullable

Base unit.

associated_unitsobjectExpandablenullable

Associated units.

objectstringenumValues:list

Object type for UnitGroupUnit list

page_infoobject

Pagination metadata for UnitGroupUnit list

next_cursorstringnullable

Cursor to fetch the next page, null if no more pages.

prev_cursorstringnullable

Cursor to fetch the previous page, null if on the first page.

has_next_pageboolean

Whether more results exist after this page.

has_prev_pageboolean

Whether results exist before this page.

dataarray of object

Array of UnitGroupUnit resources in this page

idstring

Unit group unit ID.

objectstringenumValues:unit_group_unit

Resource type identifier.

unitobjectnullable

Unit.

Always returned as null in this endpoint.

discount_percentagenumber

Discount percentage.

discount_fixednumber

Fixed discount amount.

customer_portal_visibilitystringenumValues:visiblehidden

Customer portal visibility.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

ownerobjectExpandablenullable

Owner.

objectstringenumValues:owner

Resource type identifier.

typestringenumValues:systemaccount

The owner type: "system" for platform defaults, "account" for account-owned resources.

accountobjectExpandablenullable

The account that owns this resource. null if the object is system-owned.

idstring

Account ID.

objectstringenumValues:account

Resource type identifier.

namestring

Display name.

default_billing_addressobjectnullable

Default billing address.

Always returned as null in this endpoint.

default_shipping_addressobjectnullable

Default shipping address.

Always returned as null in this endpoint.

brandingobjectnullable

Branding configuration.

Always returned as null in this endpoint.

portalobjectnullable

Portal configuration.

Always returned as null in this endpoint.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

Responses

201

Successful response for Create Unit Group

Create Unit Group

curl API_HOST/v1/catalog/unit-groups \
  -X POST \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Augno-Version: 1.0.forge-preview.1" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Weight Units",
  "type": "mass",
  "base_unit_id": "un_01jm4r6700f8nwq3v5hx2d9ktp",
  "associated_units": [
    {
      "unit_id": "un_01jm4r6700f8nwq3v5hx2d9ktp",
      "discount_percentage": 1,
      "discount_fixed": 0,
      "customer_portal_visibility": "visible"
    }
  ]
}'

curl API_HOST/v1/catalog/unit-groups \
  -X POST \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Augno-Version: 1.0.forge-preview.1" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Weight Units",
  "type": "mass",
  "base_unit_id": "un_01jm4r6700f8nwq3v5hx2d9ktp",
  "associated_units": [
    {
      "unit_id": "un_01jm4r6700f8nwq3v5hx2d9ktp",
      "discount_percentage": 1,
      "discount_fixed": 0,
      "customer_portal_visibility": "visible"
    }
  ]
}'

201 example

{
  "id": "ug_01jm4r6700f8nwq3v5hx2d9ktp",
  "object": "unit_group",
  "name": "Weight",
  "notes": null,
  "type": "mass",
  "base_unit": null,
  "associated_units": null,
  "owner": {
    "object": "owner",
    "type": "system",
    "account": null
  },
  "created_at": "2026-05-10T00:00:00Z",
  "updated_at": "2026-05-10T00:23:00Z"
}

{
  "id": "ug_01jm4r6700f8nwq3v5hx2d9ktp",
  "object": "unit_group",
  "name": "Weight",
  "notes": null,
  "type": "mass",
  "base_unit": null,
  "associated_units": null,
  "owner": {
    "object": "owner",
    "type": "system",
    "account": null
  },
  "created_at": "2026-05-10T00:00:00Z",
  "updated_at": "2026-05-10T00:23:00Z"
}

Create Unit Group

Query Parameters

Request Body

Returns

Responses