Group

A Storefront Gateway Group entity is a connective entity. It represents the grouping of multiple Users, as well as each individual user’s access to different services and functionality under an account or subscription (which are themselves represented by the Account, Subscription, and Feature entities associated to the Group entity). The typical group represents a “household” group of family members. A Storefront Gateway Group entity contains the following default properties:

Property	Definition	Type	Example
`id`	Unique internal identifier for this Group.	integer	`39846`
`type`	Specific type of Group entity.	string	`"com.uxpsystems.mint.group.UserGroup"`
`displayName`	Optional display-friendly name that the client UI can render.	string	`"The Smith Family"`
`status`	Storefront Gateway Entity status of the Group. The only possible status is activated.	string	`"activated"`
`createdDate`	Date on which this entity was created, expressed in UNIX Epoch format.	integer	`1543833950000`
`activatedDate`	Date on which this entity was activated, expressed in UNIX Epoch format.	integer	`1543833950000`
`updatedDate`	Date on which this entity was last updated, expressed in UNIX Epoch format.	integer	`1621622651675`
`suspendedDate`	Date on which this entity was suspended, expressed in UNIX Epoch format.	integer	`1527917430000`
`deactivatedDate`	Date on which this entity was deactivated, expressed in UNIX Epoch format.	integer	`1794095435804`
`attributes`	Additional metadata about the entity.

Group entities currently contain a single default attribute:

Attribute	Definition	Type	Example
`maximumNumberOfMembers`	Maximum number of Users that can be associated to the Group. Attempts to exceed this number should be forbidden.	string	`"5"`

Parent topic:Storefront Gateway Data Model

Home

Introduction

For Merchants

For Resellers

Partner Ecosystem Management

Commerce Engine

Storefront Experience

APIs