Skip to main content
POST
Use this when the user wants to create a new online storefront from scratch.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Agent-facing storefront input shape (RFC §6.18.1). Every field is PATCHable per §6.18.1.1.

name
string
required
Required string length: 1 - 100
language
enum<string>
required
Available options:
es,
en,
pt
currency
enum<string>
required
Available options:
AED,
AFN,
ALL,
AMD,
ANG,
AOA,
ARS,
AUD,
AWG,
AZN,
BAM,
BBD,
BDT,
BGN,
BHD,
BIF,
BMD,
BND,
BOB,
BRL,
BSD,
BTN,
BWP,
BYN,
BZD,
CAD,
CDF,
CHF,
CLP,
CNY,
COP,
CRC,
CUP,
CVE,
CZK,
DJF,
DKK,
DOP,
DZD,
EGP,
ERN,
ETB,
EUR,
FJD,
FKP,
GBP,
GEL,
GHS,
GIP,
GMD,
GNF,
GTQ,
GYD,
HKD,
HNL,
HTG,
HUF,
IDR,
ILS,
INR,
IQD,
IRR,
ISK,
JMD,
JOD,
JPY,
KES,
KGS,
KHR,
KMF,
KPW,
KRW,
KWD,
KYD,
KZT,
LAK,
LBP,
LKR,
LRD,
LSL,
LYD,
MAD,
MDL,
MGA,
MKD,
MMK,
MNT,
MOP,
MRU,
MUR,
MVR,
MWK,
MXN,
MYR,
MZN,
NAD,
NGN,
NIO,
NOK,
NPR,
NZD,
OMR,
PAB,
PEN,
PGK,
PHP,
PKR,
PLN,
PYG,
QAR,
RON,
RSD,
RUB,
RWF,
SAR,
SBD,
SCR,
SDG,
SEK,
SGD,
SHP,
SLE,
SOS,
SRD,
SSP,
STN,
SVC,
SYP,
SZL,
THB,
TJS,
TMT,
TND,
TOP,
TRY,
TTD,
TWD,
TZS,
UAH,
UGX,
USD,
UYU,
UZS,
VES,
VND,
VUV,
WST,
XAF,
XCD,
XOF,
XPF,
YER,
ZAR,
ZMW,
ZWL
businessType
enum<string>
required
Available options:
Restaurante,
Comida a domicilio,
Cafetería,
Bar,
Panadería y Repostería,
Alimentos en la despensa,
Bebidas Alcohólicas,
Bebidas no alcohólicas,
Licorería,
Carnicería,
Minimercado,
Tienda de barrio,
Moda,
Belleza y cuidado personal,
Barbería y salón de belleza,
Estética y salud,
Farmacia,
Gimnasio,
Joyería,
Juguetes,
Infantil,
Mascotas,
Muebles y decoración del hogar,
Artículos para el hogar,
Mejora del hogar,
Electrodomésticos,
Electrónicos,
Celulares,
Consolas y videojuegos,
Instrumentos musicales,
Herramientas,
Artículos de oficina,
Deportes,
Cultura,
Refacciones y autopartes,
Taller automotriz,
Vehículos,
Organización de eventos,
Servicios educativos,
Servicios profesionales,
Agencia de Marketing,
Otro
branding
object | null
schedule
object | null
delivery
object | null
pickup
boolean | null
dineIn
boolean | null
whatsapp
string | null
Pattern: ^\+[1-9]\d{7,14}$
biography
blocks

REPLACES the whole block list. On PATCH, send the complete array — anything you omit is removed, not merged.

Available options:
auto
categories
object[] | null

REPLACES the whole category list. On PATCH, send the complete array — categories you omit are deleted, and products still referencing them keep an orphan category string.

products
object[] | null
Maximum array length: 100
hidden
boolean | null

Response

Created

storefront
object
required
errors
object[]