Skip to main content
POST
Criar loja

Autorizações

Authorization
string
header
obrigatório

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

Corpo

application/json

Campos para criar ou atualizar uma loja. No PATCH todos são opcionais e o que for omitido não muda. Em logoObjectKey e bannerObjectKey, "" remove a imagem.

name
string
slug
string

O endereço público, de 3 a 40 caracteres: letras minúsculas, dígitos e hífens simples. Único em toda a Infi e não pode ser uma palavra reservada.

description
string | null
logoObjectKey
string | null

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

bannerObjectKey
string | null

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

theme
object

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

status
enum<string>

disabled tira a loja do ar na hora; active coloca de volta.

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

Como o comprador recebe o que comprou. Uma loja pickup nunca pede endereço; both deixa o comprador escolher no checkout.

Opções disponíveis:
pickup,
shipping,
both
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. Recusado numa loja só de retirada.

requireAddress
boolean

Pede o endereço mesmo na retirada, por exemplo para constar na nota fiscal.

Resposta

A loja criada.

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.