Create Unit Group Associated Unit

Beta
POST/v1/catalog/unit-groups/{unitGroupId}/units

Idempotent with Idempotency-Key header. Learn more

Creates an associated unit within a unit group.

unitGroupIdstring

Unit group ID.

include[]optional arrayenumValues:unit

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

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 unit ID.

objectstringenumValues:unit_group_unit

Resource type identifier.

unitobjectExpandablenullable

Unit.

idstring

Unit ID.

objectstringenumValues:unit

Resource type identifier.

namestring

Display name of the unit (e.g. "Gram", "Kilogram").

abbreviationstring

Short abbreviation for the unit (e.g. "g", "kg").

typestringenumValues:currencyquantitytime

Unit dimension.

ratio_numeratorstring (decimal)

Conversion ratio numerator relative to the base unit in the same dimension.

ratio_denominatorstring (decimal)

Conversion ratio denominator relative to the base unit in the same dimension.

offset_numeratorstring (decimal)

Conversion offset numerator, used for temperature-like conversions. Zero for most unit types.

offset_denominatorstring (decimal)

Conversion offset denominator. Typically 1.

is_base_unitboolean

Whether this is the base unit for its dimension. Conversion ratios are relative to this unit.

ownerobjectnullable

Owner of this resource.

Always returned as null in this endpoint.
created_atstring (date-time)

When this unit was created.

updated_atstring (date-time)

When this unit was last updated.

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.

Responses

201

Successful response for Create Unit Group Associated Unit