Obtener una sucursal de cliente por código

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Path Params

code

string

required

Header Params

x-api-key

string

required

Clave de API

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

Responses

🟢200Sucursal encontrada

application/json

Body

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

email

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)

id

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

name

string

Name

optional

Nombre de la ciudad

id

integer

Id

optional

Identificador único de la ciudad

code

string

Code

optional

Código de la ciudad

zone

object (Zone)

optional

name

string

optional

Nombre de la zona

id

integer

optional

Identificador único de la zona

code

string | null

optional

Código de la zona

description

string | null

optional

Descripción de la zona

isActive

boolean

optional

Indica si la zona está activa

city

object (City)

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",
  "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
}