Upnify API Docs
ERP · /suite/erp/clientes/ubicaciones

Clientes

Clientes - Ubicaciones

GET/suite/erp/clientes/ubicaciones

Obtiene las ubicaciones registradas para los clientes de la empresa autenticada. La respuesta incluye el encabezado Row-Count con el total antes de paginar.

Parámetros

NombreTipoValidaciónDescripción
ordenStringCampo de ordenamiento. Anteponer - solicita orden descendente.
textoStringTexto que se busca en la ubicación, empresa, ciudad o calle.
idPaisStringCódigo de país con el que se filtran las ubicaciones.
idEstadoStringCódigo de estado con el que se filtran las ubicaciones.
paginaIntegerNúmero de página que se consulta.
cantidadRegistrosIntegerCantidad máxima de ubicaciones por página.

Respuesta

NombreTipoDescripción
indiceIntegerPosición de la ubicación dentro del resultado.
tkEmpresaStringIdentificador del cliente propietario.
tkUbicacionStringIdentificador único de la ubicación.
ubicacionStringNombre de la ubicación.
empresaStringNombre comercial del cliente.
telefonoStringTeléfono registrado en la ubicación.
correoStringCorreo registrado en la ubicación.
idPaisStringCódigo de país de la ubicación.
idEstadoStringCódigo de estado de la ubicación.
ciudadStringCiudad de la ubicación.
codigoPostalStringCódigo postal de la ubicación.

Solicitud

Consultar ubicaciones de clientes

curl --request GET \
  --url 'https://api.upnify.com/suite/erp/clientes/ubicaciones?pagina=1&cantidadRegistros=50' \
  --header 'token: 00000000-0000-4000-8000-000000000001'

Respuesta

Ubicaciones encontradas

JSON
[
  {
    "indice": 1,
    "tkEmpresa": "00000000-0000-4000-8000-000000000010",
    "tkUbicacion": "00000000-0000-4000-8000-000000000012",
    "ubicacion": "Sucursal Centro",
    "empresa": "Empresa Ejemplo, S.A. de C.V.",
    "idPais": "MX",
    "idEstado": "ROO",
    "ciudad": "Cancún"
  }
]