Store
2 endpoints. Each needs an API key or OAuth token with the scope shown; the key already names its store, so paths start at /v1/store. Generated from the live contract; also in openapi.json.
Store settings
GET
/v1/storeOr name the store: GET /v1/stores/{storeId}
Response Store
idStoreIdrequirednamestringrequiredhandleStoreHandlerequireddomainstringrequiredcurrencyCurrencyCoderequiredpaymentModelPaymentModelrequiredplanIdPlanIdrequiredplanNamestringrequiredfeaturesFeatureKey[]requiredplanStateStorePlanState | nullrequired
8 more fields
categoryStoreCategory | nullrequiredlogoUrlstringrequiredtimezonestringrequiredownerIdUserIdrequiredtaglinestringrequiredsupportEmailEmail | nullrequiredcountryCountryCoderequiredcreatedAtTimestamprequired
Example
curl "https://api.shopfa.st/v1/store" \
-H "Authorization: Bearer $SHOPFAST_API_KEY"const res = await fetch('https://api.shopfa.st/v1/store', {
method: 'GET',
headers: {
Authorization: `Bearer ${process.env.SHOPFAST_API_KEY}`,
},
});
if (!res.ok) throw new Error((await res.json()).detail);
const data = await res.json();import os, requests
res = requests.request(
"GET",
"https://api.shopfa.st/v1/store",
headers={"Authorization": f"Bearer {os.environ['SHOPFAST_API_KEY']}"},
)
res.raise_for_status()
data = res.json()req, _ := http.NewRequest("GET", "https://api.shopfa.st/v1/store", nil)
req.Header.Set("Authorization", "Bearer "+os.Getenv("SHOPFAST_API_KEY"))
res, err := http.DefaultClient.Do(req)Try it with your key
Update store settings
PATCH
/v1/storeOr name the store: PATCH /v1/stores/{storeId}
Body
namestringtaglinestringsupportEmailstring | nullcategory"game_keys" | "game_accounts" | "software" | "courses" | "memberships" | "gift_cards" | "digital_art" | "services" | "other" | null
Response Store
idStoreIdrequirednamestringrequiredhandleStoreHandlerequireddomainstringrequiredcurrencyCurrencyCoderequiredpaymentModelPaymentModelrequiredplanIdPlanIdrequiredplanNamestringrequiredfeaturesFeatureKey[]requiredplanStateStorePlanState | nullrequired
8 more fields
categoryStoreCategory | nullrequiredlogoUrlstringrequiredtimezonestringrequiredownerIdUserIdrequiredtaglinestringrequiredsupportEmailEmail | nullrequiredcountryCountryCoderequiredcreatedAtTimestamprequired
Example
curl -X PATCH "https://api.shopfa.st/v1/store" \
-H "Authorization: Bearer $SHOPFAST_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "string",
"tagline": "string",
"supportEmail": "[email protected]",
"category": "game_keys"
}'const res = await fetch('https://api.shopfa.st/v1/store', {
method: 'PATCH',
headers: {
Authorization: `Bearer ${process.env.SHOPFAST_API_KEY}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"name": "string",
"tagline": "string",
"supportEmail": "[email protected]",
"category": "game_keys"
}),
});
if (!res.ok) throw new Error((await res.json()).detail);
const data = await res.json();import os, requests
res = requests.request(
"PATCH",
"https://api.shopfa.st/v1/store",
headers={"Authorization": f"Bearer {os.environ['SHOPFAST_API_KEY']}"},
json={
"name": "string",
"tagline": "string",
"supportEmail": "[email protected]",
"category": "game_keys"
},
)
res.raise_for_status()
data = res.json()req, _ := http.NewRequest("PATCH", "https://api.shopfa.st/v1/store", strings.NewReader(`{
"name": "string",
"tagline": "string",
"supportEmail": "[email protected]",
"category": "game_keys"
}`))
req.Header.Set("Authorization", "Bearer "+os.Getenv("SHOPFAST_API_KEY"))
req.Header.Set("Content-Type", "application/json")
res, err := http.DefaultClient.Do(req)