Shops
A shop is one website with its domains, languages and display settings. Every key belongs to exactly one shop.
The API is built and tested. Hosting at api.garanify.com is in preparation; until then it runs locally. Keys are available on request.
Inspect the current key
GET /v1/me
Key: Secret key / Publishable key
Returns the shop and key type behind the key. Works with secret and publishable keys.
Request
curl "https://api.garanify.com/v1/me" \
-H "Authorization: Bearer $GARANIFY_SECRET_KEY"import { Garanify } from '@garanify/sdk';
const garanify = new Garanify({ apiKey: process.env.GARANIFY_SECRET_KEY });
const me = await garanify.me();<?php
// composer require garanify/sdk guzzlehttp/guzzle
$factory = new GuzzleHttp\Psr7\HttpFactory();
$garanify = new Garanify\Garanify(getenv('GARANIFY_SECRET_KEY'), ['httpClient' => new GuzzleHttp\Client(), 'requestFactory' => $factory, 'streamFactory' => $factory]);
$me = $garanify->me();import os, requests
res = requests.get(
"https://api.garanify.com/v1/me",
headers={"Authorization": f"Bearer {os.environ['GARANIFY_SECRET_KEY']}"},
timeout=10,
)
res.raise_for_status()
data = res.json()Try it GET /v1/me
Response 200 application/json
{
"shop": "shp_4kq8Zt2mWc9x",
"keyId": "key_9hVb2mQx7Lp1",
"keyType": "secret",
"plan": "free",
"livemode": true
} Responses
200Key and shop. ·Me401Key missing, invalid, expired or revoked. ·Problem429Too many requests. Wait `Retry-After` seconds. ·Problem
Create another shop
POST /v1/shops
Key: Secret key
Creates a new shop in the same account as the calling key and returns its first secret and publishable key. The secrets are shown only once. An account can hold up to 100 shops (409 account_shop_limit), more on request.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
Idempotency-Key | header | string | Any unique string (for example a UUID). The same key with the same body returns the stored response for 24 hours.1–255 chars |
Body
| Name | Type | Description |
|---|---|---|
namerequired | string | 1–120 chars |
domainsrequired | Domain[] | 1–20 items |
defaultLanguage | "bg" | "cs" | "da" | "de" | "el" | "en" | "es" | "et" | "fi" | "fr" | "ga" | "hr" | "hu" | "it" | "lt" | "lv" | "mt" | "nl" | "pl" | "pt" | "ro" | "sk" | "sl" | "sv" | |
languages | "bg" | "cs" | "da" | "de" | "el" | "en" | "es" | "et" | "fi" | "fr" | "ga" | "hr" | "hu" | "it" | "lt" | "lv" | "mt" | "nl" | "pl" | "pt" | "ro" | "sk" | "sl" | "sv"[] | 1–∞ items |
settings | ShopSettings | |
settings.notice | NoticeSettings | |
settings.garan | GaranSettings |
Request
curl -X POST "https://api.garanify.com/v1/shops" \
-H "Authorization: Bearer $GARANIFY_SECRET_KEY" \
-H "Idempotency-Key: $(uuidgen)" \
-H "Content-Type: application/json" \
-d '{"name":"Second shop","domains":["second-shop.example"],"defaultLanguage":"de","languages":["de","en"]}'import { Garanify } from '@garanify/sdk';
const garanify = new Garanify({ apiKey: process.env.GARANIFY_SECRET_KEY });
const created = await garanify.shops.create({
name: 'Second shop',
domains: [
'second-shop.example'
],
defaultLanguage: 'de',
languages: [
'de',
'en'
]
});<?php
// composer require garanify/sdk guzzlehttp/guzzle
$factory = new GuzzleHttp\Psr7\HttpFactory();
$garanify = new Garanify\Garanify(getenv('GARANIFY_SECRET_KEY'), ['httpClient' => new GuzzleHttp\Client(), 'requestFactory' => $factory, 'streamFactory' => $factory]);
$created = $garanify->shops->create([
'name' => 'Second shop',
'domains' => [
'second-shop.example',
],
'defaultLanguage' => 'de',
'languages' => [
'de',
'en',
],
]);import os, uuid, requests
res = requests.post(
"https://api.garanify.com/v1/shops",
headers={"Authorization": f"Bearer {os.environ['GARANIFY_SECRET_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"name": "Second shop",
"domains": [
"second-shop.example",
],
"defaultLanguage": "de",
"languages": [
"de",
"en",
],
},
timeout=10,
)
res.raise_for_status()
data = res.json()Try it POST /v1/shops
Response 201 application/json
{
"shop": {
"id": "shp_7mPq2Vx8Ns4d",
"name": "Second shop",
"domains": [
"second-shop.example"
],
"defaultLanguage": "de",
"languages": [
"de",
"en"
],
"settings": {
"notice": {
"enabled": true,
"placements": [
"product",
"cart",
"checkout"
],
"maxWidth": 480,
"link": false
},
"garan": {
"productDisplay": "full",
"cartDisplay": "nested"
}
},
"plan": {
"id": "free",
"state": "none",
"features": [
"notice",
"allLanguages",
"garanManual",
"cartDisplay"
],
"garan": {
"limit": 25,
"used": 0,
"remaining": 25,
"canAdd": true
}
},
"livemode": true,
"createdAt": "2026-11-18T10:00:00Z",
"updatedAt": "2026-11-18T10:00:00Z"
},
"secretKey": {
"id": "key_2bRt6Hn9Qw3e",
"type": "secret",
"hint": "gfy_sk_…a1B2",
"label": null,
"createdAt": "2026-11-18T10:00:00Z",
"lastUsedDay": null,
"expiresAt": null,
"revokedAt": null,
"secret": "gfy_sk_EXAMPLEONLYa1B2"
},
"publishableKey": {
"id": "key_5cWn1Jk4Zp8r",
"type": "publishable",
"hint": "gfy_pk_…c3D4",
"label": null,
"createdAt": "2026-11-18T10:00:00Z",
"lastUsedDay": null,
"expiresAt": null,
"revokedAt": null,
"secret": "gfy_pk_7mPq2Vx8Ns4d_EXAMPLEONLYc3D4"
}
} Responses
201Shop created. ·ShopCreated401Key missing, invalid, expired or revoked. ·Problem409The request conflicts with the current state. ·Problem422The request does not match the schema. ·Problem429Too many requests. Wait `Retry-After` seconds. ·Problem
Retrieve a shop
GET /v1/shops/{shop}
Key: Secret key
Parameters
| Name | In | Type | Description |
|---|---|---|---|
shoprequired | path | string | Shop ID (shp_…).pattern ^shp_[A-Za-z0-9]{12}$ |
Request
curl "https://api.garanify.com/v1/shops/shp_4kq8Zt2mWc9x" \
-H "Authorization: Bearer $GARANIFY_SECRET_KEY"import { Garanify } from '@garanify/sdk';
const garanify = new Garanify({ apiKey: process.env.GARANIFY_SECRET_KEY });
const shop = await garanify.shops.retrieve();<?php
// composer require garanify/sdk guzzlehttp/guzzle
$factory = new GuzzleHttp\Psr7\HttpFactory();
$garanify = new Garanify\Garanify(getenv('GARANIFY_SECRET_KEY'), ['httpClient' => new GuzzleHttp\Client(), 'requestFactory' => $factory, 'streamFactory' => $factory]);
$shop = $garanify->shops->retrieve();import os, requests
res = requests.get(
"https://api.garanify.com/v1/shops/shp_4kq8Zt2mWc9x",
headers={"Authorization": f"Bearer {os.environ['GARANIFY_SECRET_KEY']}"},
timeout=10,
)
res.raise_for_status()
data = res.json()Try it GET /v1/shops/{shop}
Response 200 application/json
{
"id": "shp_4kq8Zt2mWc9x",
"name": "Mein Shop",
"domains": [
"mein-shop.example"
],
"defaultLanguage": "de",
"languages": [
"de",
"en",
"fr"
],
"settings": {
"notice": {
"enabled": true,
"placements": [
"product",
"cart",
"checkout"
],
"maxWidth": 480,
"link": false
},
"garan": {
"productDisplay": "full",
"cartDisplay": "nested"
}
},
"plan": {
"id": "pro",
"state": "active",
"features": [
"notice",
"allLanguages",
"garanManual",
"cartDisplay",
"garanUnlimited",
"garanRules",
"garanBulk"
],
"garan": {
"limit": null,
"used": 12,
"remaining": null,
"canAdd": true
}
},
"livemode": true,
"createdAt": "2026-11-18T10:00:00Z",
"updatedAt": "2026-11-18T10:05:00Z"
} Responses
200The shop. ·Shop401Key missing, invalid, expired or revoked. ·Problem404Not found. ·Problem429Too many requests. Wait `Retry-After` seconds. ·Problem
Update a shop
PATCH /v1/shops/{shop}
Key: Secret key
Changes name, domains, languages or display settings. Fields you leave out stay unchanged. While a licence is linked, the first domain (primary domain) is fixed.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
shoprequired | path | string | Shop ID (shp_…).pattern ^shp_[A-Za-z0-9]{12}$ |
Body
| Name | Type | Description |
|---|---|---|
name | string | 1–120 chars |
domains | Domain[] | 1–20 items |
defaultLanguage | "bg" | "cs" | "da" | "de" | "el" | "en" | "es" | "et" | "fi" | "fr" | "ga" | "hr" | "hu" | "it" | "lt" | "lv" | "mt" | "nl" | "pl" | "pt" | "ro" | "sk" | "sl" | "sv" | |
languages | "bg" | "cs" | "da" | "de" | "el" | "en" | "es" | "et" | "fi" | "fr" | "ga" | "hr" | "hu" | "it" | "lt" | "lv" | "mt" | "nl" | "pl" | "pt" | "ro" | "sk" | "sl" | "sv"[] | 1–∞ items |
settings | ShopSettings | |
settings.notice | NoticeSettings | |
settings.garan | GaranSettings |
Request
curl -X PATCH "https://api.garanify.com/v1/shops/shp_4kq8Zt2mWc9x" \
-H "Authorization: Bearer $GARANIFY_SECRET_KEY" \
-H "Content-Type: application/json" \
-d '{"domains":["mein-shop.example","shop.mein-shop.example"],"languages":["de","en","fr"],"settings":{"notice":{"maxWidth":520}}}'import { Garanify } from '@garanify/sdk';
const garanify = new Garanify({ apiKey: process.env.GARANIFY_SECRET_KEY });
const shop = await garanify.shops.update({
domains: [
'mein-shop.example',
'shop.mein-shop.example'
],
languages: [
'de',
'en',
'fr'
],
settings: {
notice: {
maxWidth: 520
}
}
});<?php
// composer require garanify/sdk guzzlehttp/guzzle
$factory = new GuzzleHttp\Psr7\HttpFactory();
$garanify = new Garanify\Garanify(getenv('GARANIFY_SECRET_KEY'), ['httpClient' => new GuzzleHttp\Client(), 'requestFactory' => $factory, 'streamFactory' => $factory]);
$shop = $garanify->shops->update([
'domains' => [
'mein-shop.example',
'shop.mein-shop.example',
],
'languages' => [
'de',
'en',
'fr',
],
'settings' => [
'notice' => [
'maxWidth' => 520,
],
],
]);import os, requests
res = requests.patch(
"https://api.garanify.com/v1/shops/shp_4kq8Zt2mWc9x",
headers={"Authorization": f"Bearer {os.environ['GARANIFY_SECRET_KEY']}"},
json={
"domains": [
"mein-shop.example",
"shop.mein-shop.example",
],
"languages": [
"de",
"en",
"fr",
],
"settings": {
"notice": {
"maxWidth": 520,
},
},
},
timeout=10,
)
res.raise_for_status()
data = res.json()Try it PATCH /v1/shops/{shop}
Responses
200The updated shop. ·Shop401Key missing, invalid, expired or revoked. ·Problem404Not found. ·Problem409The request conflicts with the current state. ·Problem422The request does not match the schema. ·Problem429Too many requests. Wait `Retry-After` seconds. ·Problem
Retrieve the plan
GET /v1/shops/{shop}/license
Key: Secret key
Plan and licence state of the shop. Without a licence the shop runs on Free.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
shoprequired | path | string | Shop ID (shp_…).pattern ^shp_[A-Za-z0-9]{12}$ |
Request
curl "https://api.garanify.com/v1/shops/shp_4kq8Zt2mWc9x/license" \
-H "Authorization: Bearer $GARANIFY_SECRET_KEY"import { Garanify } from '@garanify/sdk';
const garanify = new Garanify({ apiKey: process.env.GARANIFY_SECRET_KEY });
const plan = await garanify.license.retrieve();<?php
// composer require garanify/sdk guzzlehttp/guzzle
$factory = new GuzzleHttp\Psr7\HttpFactory();
$garanify = new Garanify\Garanify(getenv('GARANIFY_SECRET_KEY'), ['httpClient' => new GuzzleHttp\Client(), 'requestFactory' => $factory, 'streamFactory' => $factory]);
$plan = $garanify->license->retrieve();import os, requests
res = requests.get(
"https://api.garanify.com/v1/shops/shp_4kq8Zt2mWc9x/license",
headers={"Authorization": f"Bearer {os.environ['GARANIFY_SECRET_KEY']}"},
timeout=10,
)
res.raise_for_status()
data = res.json()Try it GET /v1/shops/{shop}/license
Response 200 application/json
{
"id": "free",
"state": "none",
"features": [
"notice",
"allLanguages",
"garanManual",
"cartDisplay"
],
"garan": {
"limit": 25,
"used": 3,
"remaining": 22,
"canAdd": true
}
} Responses
200Plan. ·Plan401Key missing, invalid, expired or revoked. ·Problem404Not found. ·Problem429Too many requests. Wait `Retry-After` seconds. ·Problem
Link a licence
PUT /v1/shops/{shop}/license
Key: Secret key
Links a Pro or Agency licence key (GRFY-…) from your Garanify account. The licence is activated for the primary domain of the shop. An Agency licence can be linked to as many shops as it has slots. Test shops have every feature without a licence and answer live_key_required.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
shoprequired | path | string | Shop ID (shp_…).pattern ^shp_[A-Za-z0-9]{12}$ |
Body
| Name | Type | Description |
|---|---|---|
keyrequired | string | Licence key from your Garanify account (GRFY-XXXX-XXXX-XXXX-XXXX).10–40 chars, pattern ^[A-Za-z0-9-]+$ |
Request
curl -X PUT "https://api.garanify.com/v1/shops/shp_4kq8Zt2mWc9x/license" \
-H "Authorization: Bearer $GARANIFY_SECRET_KEY" \
-H "Content-Type: application/json" \
-d '{"key":"GRFY-ABCD-EFGH-JKMN-PQRS"}'import { Garanify } from '@garanify/sdk';
const garanify = new Garanify({ apiKey: process.env.GARANIFY_SECRET_KEY });
const plan = await garanify.license.link('GRFY-ABCD-EFGH-JKMN-PQRS');<?php
// composer require garanify/sdk guzzlehttp/guzzle
$factory = new GuzzleHttp\Psr7\HttpFactory();
$garanify = new Garanify\Garanify(getenv('GARANIFY_SECRET_KEY'), ['httpClient' => new GuzzleHttp\Client(), 'requestFactory' => $factory, 'streamFactory' => $factory]);
$plan = $garanify->license->link('GRFY-ABCD-EFGH-JKMN-PQRS');import os, requests
res = requests.put(
"https://api.garanify.com/v1/shops/shp_4kq8Zt2mWc9x/license",
headers={"Authorization": f"Bearer {os.environ['GARANIFY_SECRET_KEY']}"},
json={
"key": "GRFY-ABCD-EFGH-JKMN-PQRS",
},
timeout=10,
)
res.raise_for_status()
data = res.json()Try it PUT /v1/shops/{shop}/license
Response 200 application/json
{
"id": "pro",
"state": "active",
"features": [
"notice",
"allLanguages",
"garanManual",
"cartDisplay",
"garanUnlimited",
"garanRules",
"garanBulk"
],
"until": "2027-11-18T00:00:00Z",
"garan": {
"limit": null,
"used": 3,
"remaining": null,
"canAdd": true
}
} Responses
200Plan after linking. ·Plan401Key missing, invalid, expired or revoked. ·Problem403Plan, key type or origin does not allow the request. ·Problem409The request conflicts with the current state. ·Problem422The request does not match the schema. ·Problem429Too many requests. Wait `Retry-After` seconds. ·Problem503A dependency is not reachable. Retry later. ·Problem
Unlink the licence
DELETE /v1/shops/{shop}/license
Key: Secret key
Releases the shop slot of the licence. The shop falls back to Free. Labels you already have stay visible.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
shoprequired | path | string | Shop ID (shp_…).pattern ^shp_[A-Za-z0-9]{12}$ |
Request
curl -X DELETE "https://api.garanify.com/v1/shops/shp_4kq8Zt2mWc9x/license" \
-H "Authorization: Bearer $GARANIFY_SECRET_KEY"import { Garanify } from '@garanify/sdk';
const garanify = new Garanify({ apiKey: process.env.GARANIFY_SECRET_KEY });
const plan = await garanify.license.unlink();<?php
// composer require garanify/sdk guzzlehttp/guzzle
$factory = new GuzzleHttp\Psr7\HttpFactory();
$garanify = new Garanify\Garanify(getenv('GARANIFY_SECRET_KEY'), ['httpClient' => new GuzzleHttp\Client(), 'requestFactory' => $factory, 'streamFactory' => $factory]);
$plan = $garanify->license->unlink();import os, requests
res = requests.delete(
"https://api.garanify.com/v1/shops/shp_4kq8Zt2mWc9x/license",
headers={"Authorization": f"Bearer {os.environ['GARANIFY_SECRET_KEY']}"},
timeout=10,
)
res.raise_for_status()
data = res.json()Try it DELETE /v1/shops/{shop}/license
Responses
200Plan after unlinking. ·Plan401Key missing, invalid, expired or revoked. ·Problem403Plan, key type or origin does not allow the request. ·Problem429Too many requests. Wait `Retry-After` seconds. ·Problem
Export evidence (CSV)
GET /v1/shops/{shop}/evidence
Key: Secret key
Evidence of what the shop shows: one notice row per shop language (placements and since when the notice has been active
with these placements, tracked from shop updates through the API) and one garan row per product with GARAN data
(active, invalid with error codes, hidden). RFC 4180, comma, CRLF, UTF-8 with BOM, times in UTC. Pro and Agency.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
shoprequired | path | string | Shop ID (shp_…).pattern ^shp_[A-Za-z0-9]{12}$ |
Request
curl "https://api.garanify.com/v1/shops/shp_4kq8Zt2mWc9x/evidence" \
-H "Authorization: Bearer $GARANIFY_SECRET_KEY"import { Garanify } from '@garanify/sdk';
const garanify = new Garanify({ apiKey: process.env.GARANIFY_SECRET_KEY });
const csv = await garanify.evidence.export();<?php
// composer require garanify/sdk guzzlehttp/guzzle
$factory = new GuzzleHttp\Psr7\HttpFactory();
$garanify = new Garanify\Garanify(getenv('GARANIFY_SECRET_KEY'), ['httpClient' => new GuzzleHttp\Client(), 'requestFactory' => $factory, 'streamFactory' => $factory]);
$csv = $garanify->evidence->export();import os, requests
res = requests.get(
"https://api.garanify.com/v1/shops/shp_4kq8Zt2mWc9x/evidence",
headers={"Authorization": f"Bearer {os.environ['GARANIFY_SECRET_KEY']}"},
timeout=10,
)
res.raise_for_status()Try it GET /v1/shops/{shop}/evidence
Response 200 text/csv
record,id,sku,name,brand,model,years,source,status,reason,language,placements,active_since,exported_at
notice,,,Legal guarantee,,,,,active,,en,product cart checkout,2026-11-18T10:00:00Z,2026-11-23T10:41:00Z
garan,WCR870,WCR870,Washing machine W1,Miele,WCR 870 WPS,10,product,active,,,,,2026-11-23T10:41:00Z Responses
200The CSV file.401Key missing, invalid, expired or revoked. ·Problem403Plan, key type or origin does not allow the request. ·Problem429Too many requests. Wait `Retry-After` seconds. ·Problem