Skip to main content
GET
Get a storefront

Authorizations

Authorization
string
header
required

Your account's secret key: Authorization: Bearer sk_test_… or sk_live_…. Server-side only.

Path Parameters

storefrontID
string<uuid>
required

Response

The storefront.

A storefront in your account.

id
string<uuid>
required
slug
string
required

The shop's public address.

name
string
required
theme
object
required

The shop's look, chosen from a fixed set of options.

status
enum<string>
required

active (live) or disabled (offline).

Available options:
active,
disabled
fulfillmentMode
enum<string>
required

How the buyer receives: pickup, shipping or both.

Available options:
pickup,
shipping,
both
requireAddress
boolean
required

Whether an address is collected even for pickup.

createdAt
string<date-time>
required
description
string | null
logoUrl
string | null

Logo image address. logoObjectKey carries the matching key.

logoObjectKey
string | null

Logo image key, from POST /catalog/images/presign.

bannerUrl
string | null

Banner image address.

bannerObjectKey
string | null

Banner image key, from POST /catalog/images/presign.

pickupNote
string | null

Pickup instructions shown to the buyer.

shippingFlatAmount
string | null

Flat shipping, as a decimal string. "0" is free; null means arranged separately.