Acceso Externo a registros de Órdenes de compra (Admin)
Permite conectarse de manera externa a los registros internos del administrador del sistema, para consultar los registros de ordenes de compras asociados a las sesiones de atenciones realizadas por los agentes con los clientes, todo esto a través de un endpoint que permite conectar con la API para consultar dichos registros usando un token unico de authorización
External Access - Admin - index (session order)
GET /v1/access/external/admin/session-orders?timeZone=America/SantiagoEste endpoint retorna la lista de las ordenes de compras de los usuarios.
Endpoint
https://api.ocularsolution.com/api/v1/access/external/admin/session-orders?timeZone=America/Santiago
Headers
Authorization
STRING
OBLIGATORIO
Valores de ejemplo: 123456789
X-Requested-With
STRING
OBLIGATORIO
Valores de ejemplo: XMLHttpRequest
Parámetros
start
TIMESTAMP
OPTIONAL
Rango de fecha para el filtrado debe estar en formato timestamp
Valores de ejemplo: 2022-03-24 01:26:04
end
TIMESTAMP
OPTIONAL
Rango de fecha para el filtrado debe estar en formato timestamp
Valores de ejemplo: 2022-03-25 01:26:04
externalId
STRING
OBLIGATORIO
opcional filtra una orden por su external Id
Valores de ejemplo: ORDER-8459
sessionOrderStateId
NUMBER
OBLIGATORIO
opcional filtra las ordenes por estados ejemplo: "pendientes" "canceladas" se debe enviar el id 1, 2 o 3
Valores de ejemplo: 2
timeZone
STRING
OBLIGATORIO
Zona Horaria
Valores de ejemplo: America/Santiago
paginate
NUMBER
OBLIGATORIO
la paginación por defecto retorna 50 columnas, y tiene un tope de 100, si se envia un numero superior el servicio retornara maximo de 100 columnas
Valores de ejemplo: 2
movementStart
TIMESTAMP
OBLIGATORIO
Fecha inicio de las historias
Valores de ejemplo: 2022-03-24 00:00:00
movementEnd
TIMESTAMP
OBLIGATORIO
Fecha fin de las historias
Valores de ejemplo: 2022-03-25 01:26:04
userId
NUMBER
OBLIGATORIO
Filtro de ordenes a traves del id de los usuarios
Valores de ejemplo: 7
Respuestas del servicio
Respuesta exitosa
{
"statusCode": 0,
"message": "Success",
"sessionOrders": {
"data": {
"current_page": 1,
"data": [
{
"id": 29,
"session_id": 1184,
"external_id": "R416577272",
"session_order_state_id": 2,
"created_at": "2022-04-11T14:54:39.000000Z",
"updated_at": "2022-04-11T14:54:39.000000Z",
"session_order_history": [
{
"session_order_id": 29,
"detail": "Orden de compra creada",
"created_at": "2022-04-11T14:54:39.000000Z",
"state": "Pendiente"
},
{
"session_order_id": 29,
"detail": "Se actualizo el estado de la orden de compra",
"created_at": "2022-04-11T14:54:39.000000Z",
"state": "Pagada"
}
],
"session_order_items": [
{
"session_order_id": 29,
"quantity": "1",
"unit_price": false,
"price": "29899.00",
"discount_type": "amount ",
"discount": "0.00",
"include_tax": true,
"tax_value": "19.0",
"currency": "CLP ",
"external_id": "578066",
"name": "Crema Multi Acción Pieles Maduras",
"image": "https://d3ha5eby3vwk14.cloudfront.net/spree/products/55251/small/578066.jpg?1619124336",
"description": "Cuidado nutritivo específico para la piel más madura gracias a su suave y sedosa textura.",
"brand": null,
"variants": [
{
"name": "Formato",
"value": "50 ml"
}
],
"category": null
}
],
"session_order_state": {
"id": 2,
"name": "Pagada"
},
"session": {
"id": 1184,
"user_id": 17,
"user": {
"id": 17,
"name": "Agente Demo",
"email": "
agente01@staging.salcobrandonline.cl
",
"profile_image": "
https://ocular-prod.s3.us-east-2.amazonaws.com/brand/1/default-cammer.png",
"user_info": []
}
}
}
],
"first_page_url": "http://apidev.ocularsolution.com/api/v1/access/external/admin/session-orders?page=1",
"from": 1,
"last_page": 1,
"last_page_url": "http://apidev.ocularsolution.com/api/v1/access/external/admin/session-orders?page=1",
"links": [
{
"url": null,
"label": "« Anterior",
"active": false
},
{
"url": "http://apidev.ocularsolution.com/api/v1/access/external/admin/session-orders?page=1",
"label": "1",
"active": true
},
{
"url": null,
"label": "Siguiente »",
"active": false
}
],
"next_page_url": null,
"path": "http://apidev.ocularsolution.com/api/v1/access/external/admin/session-orders",
"per_page": "2",
"prev_page_url": null,
"to": 1,
"total": 1
}
}
}
Respuesta fallida
{
"statusCode": 2,
"message": "Campos no cumplen",
"detail": {
"timeZone": [
"SessionOrderControllerValidator: time zone is required."
]
}
}
External Access - Admin - getOrganizationCammers
GET /v1/access/external/admin/cammers?withSessionOrder=1Este endpoint retorna la lista de todos usuarios que pertenecen a la organización, si se le pasa el parámetro: withSessionOrder con valor 1 retornara solo los usuarios que tienen una orden de compra asociada.
Endpoint
https://api.ocularsolution.com/api/v1/access/external/admin/cammers?withSessionOrder=1
Headers
Authorization
STRING
OBLIGATORIO
Valores de ejemplo: 123456789
X-Requested-With
STRING
OBLIGATORIO
Valores de ejemplo: XMLHttpRequest
Parámetros
withSessionOrder
STRING
OBLIGATORIO
opcional: si es igual a "1" filtra los usuarios de la organizaciòn que tienen una orden de compra asociada, si no se envia, el servicio retornara todos los usuarios de la organizaciòn.
Valores de ejemplo: 1
Respuestas del servicio
Respuesta exitosa
{
"statusCode": 0,
"message": "Success",
"users": {
"data": [
{
"id": 3,
"name": "Abraham Rivas",
"email": "abraham@ocularsolution.com",
"profile_image": "https://ocular-prod.s3.us-east-2.amazonaws.com/brand/1/default-cammer.png",
"organization_id": 1,
"dni": null
},
{
"id": 14,
"name": "Allan Mendez",
"email": "amendez@wingsoft.com",
"profile_image": "https://ocular-prod.s3.us-east-2.amazonaws.com/brand/1/default-cammer.png",
"organization_id": 1,
"dni": null
},
{
"id": 15,
"name": "Miguel Zolk",
"email": "zolkmiguel@gmail.com",
"profile_image": "https://ocular-prod.s3.us-east-2.amazonaws.com/brand/1/default-cammer.png",
"organization_id": 1,
"dni": null
}
]
}
}
Respuesta fallida
{
"statusCode": 9,
"message": "organizationConfigAccessToken not found"
}
External Access - Admin - listStates (Session Order State)
GET /v1/access/external/admin/session-order-statesEste endpoint retorna la lista de estados de las ordenes de compras para los filtros.
Endpoint
https://api.ocularsolution.com/api/v1/access/external/admin/session-order-states
Headers
Authorization
STRING
OBLIGATORIO
Valores de ejemplo: 123456789
X-Requested-With
STRING
OBLIGATORIO
Valores de ejemplo: XMLHttpRequest
Respuestas del servicio
Respuesta exitosa
{
"statusCode": 0,
"message": "Success",
"sessionOrderStates": {
"data": [
{
"id": 1,
"name": "Pendiente"
},
{
"id": 2,
"name": "Pagada"
},
{
"id": 3,
"name": "Cancelada"
}
]
}
}
Respuesta fallida
{
"statusCode": 9,
"message": "organizationConfigAccessToken not found"
}