Sign in

v1

latestSwagger 2.02026-08-045928532.7 MB
CatalogGroups

Get group by Id

[BETA - this endpoint is under development, do not use it in your production system]

get/api/v1.0/{appId}/catalog/groups/{catalogItemId}

Path parameters

appIdstring required
catalogItemIdstring required

Response

OK

CatalogGroupIdstring

Unique catalog group id

CatalogItemIdstring

Unique catalog item id

IsArchivedboolean

Returns true if the group is archived

MinSelectCountinteger

Minimum number of items that the user has to select

MaxSelectCountinteger nullable

Maximum number of items that the user has to select

GroupType'ModifierGroup' required

Type of group (ModifierGroup, etc)

Skustring required

Stock Keeping Unit (SKU)

Namestring required

Group name

AutogenerateDisplayTextboolean

Autogenerate display text in ordering applications

ImageFileNamestring

Image File Name