Skip to main content

​
🏗️ Criar Loja

Este endpoint permite criar uma nova loja associada à sua conta. Ele é ideal para:
  • Provisionar lojas automaticamente
  • Criar lojas em fluxos de onboarding
  • Integrar CRMs e sistemas externos com a caBRAPI

​
🔐 Autenticação

Esta rota exige autenticação via API Key, enviada no header da requisição: 
Authorization: SUA_API_KEY_AQUI

​
📥 Body da Requisição

CampoTipoObrigatórioDescrição
templatestringSimValores aceitos: PERSONALIZADO ou N/A.
namestringNãoNome da loja (mín. 4, máx. 32).
descriptionstring | nullNãoDescrição da loja (mín. 12, máx. 256).
imagestring | nullNãoURL da imagem da loja (mín. 12, máx. 512).
metadataobject | nullNãoMetadados customizados da loja.
domainobject | nullCondicionalObrigatório quando template = PERSONALIZADO.

​
Estrutura de domain

CampoTipoObrigatórioDescrição
typestringSimValores aceitos: CUSTOM ou DEFAULT.
valuestringSimDomínio ou subdomínio (mín. 8, máx. 75).

​
📋 Exemplo de Requisição

curl --location "https://api.cabrapi.com.br/stores" \
--header "Authorization: SUA_API_KEY_AQUI" \
--header "Content-Type: application/json" \
--data '{
	"name": "Minha Loja",
	"description": "Loja oficial da minha marca",
	"image": "https://example.com/store.png",
	"template": "PERSONALIZADO",
	"domain": {
		"type": "DEFAULT",
		"value": "minha-loja"
	}
}'

​
📊 Exemplo de Resposta

{
	"status": true,
	"code": "STORE_CREATED",
	"store": {
		"id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
		"name": "Minha Loja",
		"position": 1,
		"description": "Loja oficial da minha marca",
		"image": "https://example.com/store.png",
		"domain": "minha-loja-web.cabrapi.com.br",
		"template": "PERSONALIZADO",
		"metadata": null,
		"createdAt": "2026-02-28T12:00:00.000Z",
		"updatedAt": "2026-02-28T12:00:00.000Z"
	}
}

​
❌ Possíveis Erros

StatusCodeQuando acontece
400INVALID_DATADados de entrada inválidos.
400DOMAIN_REQUIREDtemplate é PERSONALIZADO, mas domain não foi enviado.
400DOMAIN_ALREADY_EXISTSDomínio já está sendo usado por outra loja.
400NAME_ALREADY_EXISTSJá existe loja com esse nome para o mesmo usuário.
403STORE_LIMIT_REACHEDLimite de lojas do plano foi atingido.
500INTERNAL_SERVER_ERRORFalha interna ao processar a requisição.

​
🔗 Links Úteis

Update: 28/02/2026 as 00:00