Skip to main content
POST
Criar cliente

Authorizations

User-Token
string
header
required
User-Secret-Key
string
header
required

Path Parameters

alias
string
required

Alias da loja

Body

application/json

Representa os dados necessários para criar ou atualizar um cliente

active
boolean
required

Status do cliente

type
enum<string>
required

Tipo de cliente (f para físico, j para jurídico)

Available options:
f,
j
cpf
string
required

CPF do cliente

cnpj
string | null
required

CNPJ do cliente

email
string
required

E-mail do cliente

homephone
string
required

Telefone residencial

marketplace_id
integer | null

ID do marketplace

cluster_id
integer | null

ID do cluster

name
string

Nome do cliente

razao_social
string | null

Razão social

birthday
string<date-time>

Esse campo somente se torna obrigatório caso haja configuração da regra no checkout. Data de aniversário do cliente.

Example:

"2000-06-01"

ip
string

IP do cliente

utm_source
string

Fonte UTM

utm_campaign
string

Campanha UTM

notes
string

Notas sobre o cliente

Response

Cliente criado com sucesso

data
Customer · object[]