Para poder consultar los clientes es necesario tener un usuario de API y conocer las tiendas sobre las cuales queremos consultar.

PUT: https://api.rayapp.io/segments/users?orderBy=registrationDate&pageNumber=1&pageSize=10&getIgnoredAndBlacklisted=true&direction=DESC

Contenido del BODY:

{   
"stores":[
{ "id" : 3 }
],
"filters":[],
"useCompanyUsers":false,
"useCompanyEvents":false
}

Parámetro

Descripción

pageNumber

número de página, la primera página es la 1

pageSize

cantidad de resultados por página

orderBy

campo por el cual ordenar

  • registrationDate: fecha de registro

direction

ordenamiento

  • ASC: ascendente

  • DESC: descendente

getIgnoredAndBlacklisted

false: filtrar clientes que estan marcados como ignorados o blacklisteados

true: traer todos los clientes

BODY.stores

lista de ids de tiendas donde los clientes están registrados

BODY.filters

enviar como está en el ejemplo

BODY.useCompanyUsers

enviar como está en el ejemplo

BODY.useCompanyEvents

enviar como está en el ejemplo

Respuesta: lista de clientes registrados

"data": {
"users": [
{
"id": 4129004,
"name": "Gonza",
"lastName": "",
"email": "testsetupcreate5@mail.com",
"gender": "M",
"location": null,
"company": null,
"avatar": null,
"birthDate": null,
"role": null,
"phone": null,
"loggedInThrough": null,
"facebookProfile": null,
"googleProfile": null,
"linkedInProfile": null,
"twitterProfile": null,
"instagramProfile": null,
"country": null,
"qrCode": null,
"identityNumber": null,
"visitorType": null,
"sonBirthDate": null,
"tags": [],
"storeRegistrations": [
{
"storeId": 3,
"storeCompanyId": 3,
"userId": 4129004,
"lastVisitationDate": null,
"ignored": false,
"ignoredBy": null,
"ignoredTimestamp": null,
"registrationDate": 1656344076000,
"registeredThrough": {
"id": "Manual",
"name": "Manual"
}
}
],
"ignored": null,
"province": null,
"registeredBy": null,
"userDisplayName": "Gonza"
}
]
},
"result": "success",
"message": "ok",
"statusCode": 200
}

Campo

Descripción

user.id

id del usuario, este dato debe utilizarse para el servicio de consulta de actividad de usuario LINK A DOCUMENTO 4

user.*

datos del cliente (nombre, apellido, etc)

user.storeRegistrations.*

dado que un cliente puede estar registrado en más de una tienda, esta lista contiene para cada tienda información del registro

Artículos relacionados:

Cómo: obtener mis tiendas y empresas por API en RAY?

Visita nuestro Help Center, allí encontrarás más información para continuar aprendiendo sobre la plataforma.


¿Qué te pareció este artículo? 👇

¿Encontró su respuesta?