Skip to main content
POST
Crear un cliente

Authorizations

x-api-key
string
header
required

API key del comercio. Se genera desde el panel de Tienda de Puntos, en Configuración → Integraciones.

Headers

x-branch-id
integer

ID de la sucursal en la que se registra la operación. Si se omite, la operación queda asociada al comercio sin sucursal.

Example:

1972

Body

application/json
firstName
string

Nombre del cliente.

Example:

"Juan Manuel"

lastName
string

Apellido del cliente.

Example:

"Pérez"

email
string

Email del cliente. Obligatorio si no mandás documentNumber.

Example:

"juanma@mailinator.com"

documentNumber
string

Número de documento. Obligatorio si no mandás email.

Example:

"40100800"

documentType
string

Tipo de documento. Si se omite, se infiere por el país del comercio. Usá PASSPORT para documentos extranjeros alfanuméricos.

Example:

"DNI"

phone
string

Teléfono del cliente.

Example:

"+541164593678"

birthday
string

Fecha de nacimiento en ISO 8601. Si el comercio tiene una edad mínima configurada, se valida contra ella.

Example:

"1990-01-01"

gender
enum<number>

Género. 0 = masculino, 1 = femenino, 2 = otro, 3 = sin datos.

Available options:
0,
1,
2,
3
Example:

3

affiliateCard
string

Número de tarjeta de afiliado. Tiene que ser único dentro del comercio.

Example:

"00012345"

description
string

Observaciones internas del comercio sobre el cliente.

Example:

"Alta desde el POS de la sucursal Centro."

branchId
number

Sucursal en la que se registra el cliente. Los IDs salen de GET /external/branch. También se puede mandar en el header x-branch-id.

Example:

1972

tagIds
number[]

IDs de las etiquetas del comercio que se le asignan al cliente.

Example:

Response

Cliente creado.

success
boolean
required
Example:

true

status
integer
required
Example:

201

message
string
required
Example:

"Request was successful"

data
object