ShopEazydevelopers
API referenceStorefront APIStore

The store's public profile

Credentials
  • Store key
Scopes
catalog:read
GET
/v1/store

Public profile, brand, storefront config, shipping settings, the membership gate, the shopper sign-in tenant (auth.tenantId) and whether a card checkout can be opened (payments.canCharge). No credentials or billing fields are ever returned.

If the payment-provider lookup fails the store still loads, with payments.canCharge: false.

Authorization

storeKey catalog:read
headerAuthorizationBearer <sez_pub_... (publishable) or sez_sk_... (secret)>

A per-store key from the console. Publishable keys are browser-safe; secret keys are server-only.

Scope: catalog:read

Response Body

The store.

application/json
  1. response
data*
Example Request
curl -X GET 'https://api.shopeazy.co/v1/store' \  -H 'Authorization: Bearer sez_pub_...'
Example Response
{  "data": {    "id": "w82oaN7OkGK7BykWs2Ag",    "name": "Jabu's Plant Shop",    "subdomain": "jabus-plant-shop",    "customDomain": null,    "description": "Houseplants, pots and plant care in Johannesburg.",    "currency": "ZAR",    "supportEmail": null,    "supportPhone": "+27 82 000 0000",    "brand": null,    "storefront": {      "themeId": "market",      "palette": {        "primary": "#e63946",        "accent": "#f4a261",        "background": "#fffdf8",        "foreground": "#1d3557"      },      "radius": "round",      "hero": {        "headline": "Made by hand, made to keep",        "subcopy": "Small batches, made with care.",        "ctaLabel": "Shop now",        "ctaTarget": "physical"      },      "sections": [        {          "id": "kit-cbzXdyoC08TecFtCKeTn",          "type": "kit",          "visible": true,          "label": "Shop",          "kitType": "physical"        },        {          "id": "kit-COtS8ZNhRzJniQOjM8lh",          "type": "kit",          "visible": true,          "label": "Services",          "kitType": "service"        },        {          "id": "kit-aZbiVcGfoLKeB5H6Cvu5",          "type": "kit",          "visible": true,          "label": "Tickets",          "kitType": "ticketing"        }      ]    },    "shipping": null,    "location": {      "country": "ZA",      "province": "Gauteng",      "city": "Johannesburg",      "postalCode": "2193",      "localArea": "Greenside",      "addressLine": "12 Example Street"    },    "membership": {      "enabled": false,      "gate": "checkout",      "requireVerification": false,      "applicationNote": null    },    "auth": {      "tenantId": "jFV6cl7HniY4C1iadt58eio"    },    "payments": {      "provider": null,      "name": null,      "canCharge": false    }  }}

Storefront API

Every Storefront API operation, with its scopes, parameters, responses and request samples.

List active items GET

Active **physical** products by default. `?kind=service`, `?kind=ticketing` or `?kind=tour` returns that kind instead; `?kind=all` returns every active item across kits. `?category=<slug>` narrows to one category and its children (coming soon). A tour's own `details` (schedule, price bands, meeting points) are coming soon. Cost and margin fields are never returned. Any other `kind` is `400 invalid_parameter`. Paged: `{ items, nextCursor }`, `limit` (default 100, at most 200) and an opaque `cursor`. Old path, deprecated, sunset 1 Feb 2027: `GET /v1/products`.