Skip to main content
GET
Get one online storefront

Authorizations

X-API-Key
string
header
required

Path Parameters

retailer_id
string<shortuuid>
required

Unique identifier of the retailer this storefront belongs to.

Required string length: 22
Pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$
storefront_id
string<shortuuid>
required

Unique identifier of the storefront.

Required string length: 22
Pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$

Response

OK

One online storefront as the catalog holds it.

Distinct from StorefrontOut in listings.py, which is the result of a write — it carries created: true/false for "did this call create the row" and would be meaningless on a read.

id
string<shortuuid>
required

URL-safe 22-character shortuuid encoding of the row's UUID primary key. Stable across the row's lifetime; suitable for sharing in URLs, log lines, and external SDK clients. Accepted on input as either the shortuuid form or the canonical UUID form (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx).

Required string length: 22
Pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$
retailer_id
string<shortuuid>
required

URL-safe 22-character shortuuid encoding of the row's UUID primary key. Stable across the row's lifetime; suitable for sharing in URLs, log lines, and external SDK clients. Accepted on input as either the shortuuid form or the canonical UUID form (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx).

Required string length: 22
Pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$
name
string
required

Display name of the web property.

url
string
required

Root URL of the storefront — its identity within the retailer, and the value a listing's urls[].store_url matches against.

platform
enum<string>
required

E-commerce software or marketplace powering the store. unknown is a valid answer.

Available options:
shopify,
bigcommerce,
woocommerce,
magento,
salesforce_commerce,
sap_hybris,
squarespace,
wix,
webflow,
prestashop,
opencart,
custom,
amazon,
walmart,
etsy,
ebay,
target_plus,
unknown
is_active
boolean
required

False for a retired property. Only active storefronts may be referenced by a listing URL, and DELETE clears this flag rather than removing the row.

created
string<date-time>
required

When this storefront row was first written.

modified
string<date-time>
required

When this storefront row last changed.

country
string
default:""

Primary country this storefront serves, ISO 3166-1 alpha-2.

locale
string
default:""

BCP 47 locale tag the storefront presents in, e.g. en-CA.

currency
string
default:""

ISO 4217 code this storefront transacts in.