Obtener cliente por código

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Código único del cliente

Responses

🟢200Respuesta exitosa

application/json

Body

name

string

optional

Nombre del cliente

code

string

optional

Código único del cliente

business_name

string | null

optional

Nombre comercial del cliente (puede ser nulo)

alias

string | null

optional

Alias o nombre alternativo del cliente (puede ser nulo)

identification

string

optional

Número de identificación del cliente

website

string | null

optional

Sitio web del cliente (puede ser nulo)

string | null

optional

Correo electrónico principal del cliente (puede ser nulo)

phone

string | null

optional

Número de teléfono principal del cliente (puede ser nulo)

status

integer

optional

Estado del cliente (1: activo, 0: inactivo)

visibility

string

optional

Visibilidad del cliente en el sistema

is_blocked

boolean

optional

Indica si el cliente está bloqueado

type

string

optional

Tipo de cliente (ej: CUSTOMER)

integer

optional

ID interno del cliente en el sistema

id_account_customer_type

integer

optional

ID del tipo de cuenta del cliente

created_source

string

optional

Fuente de creación del cliente (ej: WS para Web Service)

typeCustomer

object

optional

name

string

optional

Nombre del tipo de cliente

integer

optional

ID del tipo de cliente

description

string

optional

Descripción del tipo de cliente

created_at

string <date-time>

optional

Fecha y hora de creación del cliente

created_by

integer

optional

ID del usuario que creó el cliente

updated_at

string <date-time>

optional

Fecha y hora de la última actualización del cliente

updated_by

integer

optional

ID del usuario que realizó la última actualización del cliente

branches

array[object (ClientBranch) {32}]

optional

Lista de sucursales asociadas al cliente

name

string

optional

Nombre de la sede o sucursal del cliente

code

string

optional

Código único de la sede o sucursal del cliente.

alias

string | null

optional

Alias o nombre alternativo de la sucursal

coords

string

optional

Coordenadas geográficas de la sucursal (formato: "latitud;longitud")

radius

string

optional

Radio de cobertura o alcance de la sucursal en metros

radius_min

string

optional

Distancia mínima para marcaciones de operación interna en metros

address

string

optional

Dirección física de la sucursal

country_name

string

optional

Nombre del país donde se encuentra la sucursal

state_name

string

optional

Nombre del estado o provincia donde se encuentra la sucursal

city_name

string

optional

Nombre de la ciudad donde se encuentra la sucursal

phone

string | null

optional

Número de teléfono principal de la sucursal

phone_alt

string | null

optional

Número de teléfono alternativo de la sucursal

string | null

optional

Dirección de correo electrónico principal de la sucursal

email_alt

string | null

optional

Dirección de correo electrónico alternativa de la sucursal

extra1

string | null

optional

Campo adicional 1 para información extra

extra2

string | null

optional

Campo adicional 2 para información extra

extra3

string | null

optional

Campo adicional 3 para información extra

extra4

string | null

optional

Campo adicional 4 para información extra

extra5

string | null

optional

Campo adicional 5 para información extra

status

integer

optional

Estado de la sucursal (1 = activo, 0 = inactivo)

integer

optional

ID de la sede o sucursal del cliente

id_account_customer

integer

optional

Identificador de la cuenta del cliente asociado

id_account_geo_city

integer

optional

Identificador de la ciudad en la geografía de la cuenta

id_account_geo_zone

integer

optional

Identificador de la zona en la geografía de la cuenta

created_source

string

optional

Fuente de creación de la sucursal

city

object (City)

optional

zone

object (Zone)

optional

updated_ws_at

string <date-time> | null

optional

Fecha y hora de la última actualización por web service

created_at

string <date-time>

optional

Fecha y hora de creación de la sucursal

created_by

integer

optional

Identificador del usuario que creó la sucursal

updated_at

string <date-time>

optional

Fecha y hora de la última actualización de la sucursal

updated_by

integer

optional

Identificador del usuario que actualizó por última vez la sucursal

Example

{
  "name": "string",
  "code": "string",
  "business_name": "string",
  "alias": "string",
  "identification": "string",
  "website": "string",
  "email": "string",
  "phone": "string",
  "status": 0,
  "visibility": "string",
  "is_blocked": true,
  "type": "string",
  "id": 0,
  "id_account_customer_type": 0,
  "created_source": "string",
  "typeCustomer": {
    "name": "string",
    "id": 0,
    "description": "string"
  },
  "created_at": "2019-08-24T14:15:22Z",
  "created_by": 0,
  "updated_at": "2019-08-24T14:15:22Z",
  "updated_by": 0,
  "branches": [
    {
      "name": "string",
      "code": "string",
      "alias": "string",
      "coords": "string",
      "radius": "string",
      "radius_min": "string",
      "address": "string",
      "country_name": "string",
      "state_name": "string",
      "city_name": "string",
      "phone": "string",
      "phone_alt": "string",
      "email": "string",
      "email_alt": "string",
      "extra1": "string",
      "extra2": "string",
      "extra3": "string",
      "extra4": "string",
      "extra5": "string",
      "status": 0,
      "id": 0,
      "id_account_customer": 0,
      "id_account_geo_city": 0,
      "id_account_geo_zone": 0,
      "created_source": "string",
      "city": {
        "name": "string",
        "id": 0,
        "code": "string"
      },
      "zone": {
        "name": "string",
        "id": 0,
        "code": "string",
        "description": "string",
        "isActive": true,
        "city": {
          "name": "string",
          "id": 0,
          "code": "string"
        }
      },
      "updated_ws_at": "2019-08-24T14:15:22Z",
      "created_at": "2019-08-24T14:15:22Z",
      "created_by": 0,
      "updated_at": "2019-08-24T14:15:22Z",
      "updated_by": 0
    }
  ]
}

Request

Request samples

Responses