Every export returns a fresh copy of the data. Mutating a returned table never affects the resource.
GetShop
Returns the full shop record (fresh from the database), ornil if no shop with that id exists.
string
required
The shop id to look up.
id, title, balance, ownerIdentifier, ownerName, forSale, salePrice and an inventory array of listings.
GetAllShops
Returns every shop keyed by id. This reads one row per shop plus its inventory, so use it for one-off discovery or enumeration rather than per-frame reads.GetShopBalance
Returns the shop’s current balance as a number, ornil if no such shop exists.
string
required
The shop id to read the balance of.
GetShopOwner
Returns owner info for a shop, ornil if no such shop exists. identifier and name are nil when the shop is server-run or currently for sale.
string
required
The shop id to read ownership of.
GetOwnedShops
Returns an array of the full shop records owned by an identifier. Employees are excluded (ownership only). Empty if the identifier owns nothing.string
required
The player identifier to list owned shops for.
IsShopEmployee
Returnstrue only if the identifier is a hired employee of the shop. The owner is not counted as an employee, so check GetShopOwner for ownership.
string
required
The shop id to check.
string
required
The player identifier to check.
GetShopEmployees
Returns an array of employee records for a shop (empty if none, or if no such shop exists). Each record includesidentifier, name, role, permissions and commission info.
string
required
The shop id to list employees for.
GetShopStats
Returns sales stats for a shop, ornil if no such shop exists. The stats are tenure-scoped to the current owner (they reset on every ownership change), matching what the owner sees on the management dashboard.
string
required
The shop id to read stats for.
Looking for an export we don’t have listed here? Contact us and we’ll do what we can!