La documentación que estás leyendo no cuenta con los últimos cambios. ¡Revisa nuestra documentación actualizada!
Listar usuarios creados en Bsale.
Listar ventas y devoluciones por usuario
Al realizar una petición HTTP, el servicio retornara un JSON con la siguiente estructura:
{
"href": "https://api.bsale.cl/v1/users.json",
"count": 2,
"limit": 25,
"offset": 0,
"items": [
{
"href": "https://api.bsale.cl/v1/users/2.json",
"id": 2,
"firstName": "Gabriel",
"lastName": "Seguel",
"email": "gseguel@imaginex.cl",
"state": 0,
"office": {
"href": "https://api.bsale.cl/v1/offices/1.json",
"id": "1"
}
},
{
"href": "https://api.bsale.cl/v1/users/1.json",
"id": 1,
"firstName": "Soporte ",
"lastName": "bsale",
"email": "mmunoz@imaginex.cl",
"state": 0,
"office": {
"href": "https://api.bsale.cl/v1/offices/1.json",
"id": "1"
}
}
]
}
GET /v1/users.json
retornara todos los usuarios.Parámetros
Ejemplos
GET /v1/users.json?limit=10&offset=0
GET /v1/users.json?fields=[firstname,lastname]
GET /v1/users.json?officeid=1
GET /v1/users.json?expand=[office]
GET /v1/users.json?state=0
Respuesta
{
"href": "http://localhost:9292/v1/users.json",
"count": 121,
"limit": 2,
"offset": 0,
"items": [
{
"href": "https://api.bsale.cl/v1/users/32.json",
"id": 32,
"firstName": "Alejandro",
"lastName": "Herrera",
"email": "ah@gmail.com",
"state": 0,
"office": {
"href": "https://api.bsale.cl/v1/offices/2.json",
"id": "2"
}
},
{
"href": "https://api.bsale.cl/v1/users/88.json",
"id": 88,
"firstName": "Andrés",
"lastName": "Oyarzo",
"email": "aoyarzo@gmail.com",
"state": 1,
"office": {
"href": "https://api.bsale.cl/v1/offices/2.json",
"id": "2"
}
}
],
"next": "https://api.bsale.cl/v1/users.json?limit=2&offset=2"
}
GET /v1/users/32.json
retornara un usuario específico.Parámetros
Ejemplos
GET /v1/clients/32.json?expand=[office]
Respuesta
{
"href": "https://api.bsale.cl/v1/users/1.json",
"id": 1,
"firstName": "Juan",
"lastName": "Otto",
"email": "ottoj@gmail.com",
"state": 0,
"office": {
"href": "https://api.bsale.cl/v1/offices/1.json",
"id": "1"
}
}
GET /v1/users/sales_summary.json
retorna las ventas de los usuarios dentro de un rango de fecha. (Requiere uso de filtro)Parámetros
Ejemplos
GET /v1/users/sales_summary.json?userid=113
GET /v1/users/sales_summary.json?startdate=1438560000&enddate=1438560000
GET /v1/users/sales_summary.json?startdate=1438560000&enddate=1438560000&userid=113
Respuesta
{
"startDate": 1576022400,
"endDate": 1576022400,
"total": 22500.0,
"sellers": [
{
"href": "https://api.bsale.cl/v1/users/2.json",
"id": 2,
"fullName": "Gabriel Seguel",
"subtotal": 7500.0,
"taxSubtotal": 1197.0,
"sales": {
"href": "https://api.bsale.cl/v1/users/2/sales.json?startdate=1576022400&enddate=1576022400"
},
"returns": {
"href": "https://api.bsale.cl/v1/users/2/returns.json?startdate=1576022400&enddate=1576022400"
}
},
{
"href": "https://api.bsale.cl/v1/users/1.json",
"id": 1,
"fullName": "Soporte bsale",
"subtotal": 15000.0,
"taxSubtotal": 2395.0,
"sales": {
"href": "https://api.bsale.cl/v1/users/1/sales.json?startdate=1576022400&enddate=1576022400"
},
"returns": {
"href": "https://api.bsale.cl/v1/users/1/returns.json?startdate=1576022400&enddate=1576022400"
}
}
]
}
GET /v1/users/128/sales.json
retorna los documentos de venta asignados al usuario.Parámetros
Ejemplos
GET /v1/users/128/sales.json?startdate=1438560000&enddate=1438560000
Respuesta
{
"href": "https://api.bsale.cl/v1/users/1/sales.json?startdate=1576022400&enddate=1576022400",
"count": 1,
"limit": 25,
"offset": 0,
"items": [
{
"href": "https://api.bsale.cl/v1/documents/83.json",
"id": 83,
"name": "BOLETA MANUAL (no valido al SII)",
"number": 39
}
]
}
GET /v1/users/128/returns.json
retorna los documentos de venta asignados al usuario.Parámetros
Ejemplos
GET /v1/users/2/returns.json?startdate=1570884055000&enddate=1576154470
Respuesta
"href": "https://api.bsale.cl/v1/users/128/returns.json?startdate=1438560000&enddate=1438560000",
"count": 2,
"limit": 25,
"offset": 0,
"items": [
{
"href": "https://api.bsale.cl/v1/documents/6604.json",
"id": 6604,
"name": "Nota de crédito",
"number": 50
},
{
"href": "https://api.bsale.cl/v1/documents/6606.json",
"id": 6606,
"name": "Nota de crédito",
"number": 60
}
]
}