Runtime

A Runtime entity represents the software on which Storefront Gateway is being accessed. Typical Runtime examples include web browsers on desktops, applications on mobile devices, or the firmware in embedded devices. In an example where a native mobile application on an iPhone is accessing Storefront Gateway, Storefront Gateway considers the application itself to be the runtime, not the underlying operating system (iOS) or the physical device itself (the iPhone). The manipulation of Runtimes (that is, Runtime entities) is restricted to creating them, deleting them, and editing their Attributes (if any). Runtimes and Users may have many-to-many relationships (i.e., associations). A Runtime entity has the following default properties:

Property	Definition	Type	Example
`id`	Unique internal identifier for this Runtime.	integer	`3298435`
`type`	Specific type of Runtime entity.	string
`displayName`	Optional display-friendly name for the Runtime.	string	`"Jane's Android 4.1.1"`
`status`	Entity status of the Runtime.	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`
`guid`	Unique identification string for the actual Runtime.	string	`"DEF123"`
`version`	The Storefront Gateway client software’s version.	string	`"4.1.1"`
`buildType`	The type of build for the Storefront Gateway client software (Ex. “Development Build”, “Production Build”).	string	`"Production"`
`platformType`	The OS that the client software is running on.	string	`"android"`
`deviceType`	The Device form factor that the software is running on (Ex. “tablet”, “PC”).	string	`"mobile"`
`customer`	The Operator’s name.	string	`"Apple"`
`userAgent`	The HTTP user agent for this Runtime.	string	`"Mozilla/5.0 (Linux; U; Android 4.1.1; en-us; rk30sdk Build/JRO03H) AppleWebKit/534.30 (KHTML, like Gecko) Version/4.0 Safari/534.30"`
`attributes`	Additional metadata about the entity.

Currently, Storefront Gateway Runtimes have no default attributes. However, Runtimes support attributes so that they can be easily provisioned in subsequent release versions of Storefront Gateway. Parent topic:Storefront Gateway Data Model

Home

Introduction

For Merchants

For Resellers

Partner Ecosystem Management

Commerce Engine

Storefront Experience

APIs