Skip to main content
GET
Ler loja

Autorizações

Authorization
string
header
obrigatório

Chave secreta da conta: Authorization: Bearer sk_test_… ou sk_live_…. Use só no servidor.

Parâmetros de caminho

storefrontID
string<uuid>
obrigatório

Resposta

A loja.

Uma loja da sua conta.

id
string<uuid>
obrigatório
slug
string
obrigatório

O endereço público da loja.

name
string
obrigatório
theme
object
obrigatório

A aparência da loja, escolhida entre opções fixas.

status
enum<string>
obrigatório

active (no ar) ou disabled (fora do ar).

Opções disponíveis:
active,
disabled
fulfillmentMode
enum<string>
obrigatório

Como o comprador recebe: pickup (retirada), shipping (envio) ou both.

Opções disponíveis:
pickup,
shipping,
both
requireAddress
boolean
obrigatório

Se o endereço é pedido mesmo na retirada.

createdAt
string<date-time>
obrigatório
description
string | null
logoUrl
string | null

Endereço da imagem do logo. logoObjectKey traz a chave correspondente.

logoObjectKey
string | null

Chave da imagem do logo, de POST /catalog/images/presign.

bannerUrl
string | null

Endereço da imagem do banner.

bannerObjectKey
string | null

Chave da imagem do banner, de POST /catalog/images/presign.

pickupNote
string | null

Instruções de retirada mostradas ao comprador.

shippingFlatAmount
string | null

Frete fixo, em texto decimal. "0" é grátis; null é combinado por fora.