Reference
Shop API
Every shop endpoint, its fields and an example.
Generated from FOM's OpenAPI document. Every request needs an API key; see Authentication.
The shop object
| Field | Type | Description |
|---|---|---|
shop | object | |
shop.id | string | |
shop.name | string | e.g. Ma Aye Shop |
shop.timezone | string | e.g. Asia/Yangon |
api_key | object | |
api_key.name | string | e.g. POS sync |
api_key.scopes | array of string | |
api_key.acts_for | string | The member the key acts for. e.g. Ma Aye |
The shop this API key belongs to
GET /public/v1/shopScope: any working key
Any working key can call this. Use it to check a key and see its scopes.
Returns
The shop (The shop object).
Example
curl "https://api.getfom.com/public/v1/shop" \
-H "Authorization: Bearer $FOM_API_KEY"