get
https://www.cloud.wispro.co/api/v1/order/orders
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
Atributos
| Atributo | Tipo | Descripción | Requerido |
|---|---|---|---|
| id | String | UUID de la orden | Si |
| state | String | Estado de la orden. Los estados disponibles son:
| Si |
| result | String | Resultado de la orden. Los resultados posibles son:
| Si |
| kind | String | Tipo de la orden. Los estados disponibles son:
| Si |
| description | String | Descripción de la orden | No |
| parent_order_id | String | UUID de la orden padre | No |
| ticketable_id | String | UUID del ticket de mesa o venta | No |
| ticketable_type | String | Tipo de ticket (HelpDesk/SaleDesk) | No |
| orderable_id | String | UUID del contrato o prospecto | No |
| orderable_type | String | Tipo de contrato (Contract/Prospect) | No |
| start_at | Date | Hora programada para el inicio de la orden | No |
| end_at | Date | Hora programada para el fin de la orden | No |
| initialized_at | Date | Hora en la que inicio la orden | No |
| finalized_at | Date | Hora en la que finalizo la orden | No |
| status | Integer | Código de estado de la respuesta. Ejemplo: 200. | Si |
| meta | Object | Objeto que contiene información general de la respuesta. | Si |
| meta.object | String | Tipo de objeto devuelto por la API. Para este endpoint devuelve order. | Si |
| meta.pagination | Object | Objeto que contiene información de paginación del listado. | Si |
| meta.pagination.total_records | Integer | Cantidad total de registros encontrados para la consulta realizada. | Si |
| meta.pagination.total_pages | Integer | Cantidad total de páginas disponibles según la cantidad de registros y el límite por página. | Si |
| meta.pagination.per_page | Integer | Cantidad de registros devueltos por página. | Si |
| meta.pagination.current_page | Integer | Número de página actual devuelta por la API. | Si |
| data | Array | Listado de órdenes devueltas por la API. Cada elemento del array corresponde a una orden. | Si |
| sequential_id | Integer | Identificador secuencial de la orden. | Si |
| isp_id | String | UUID del ISP asociado a la orden. | Si |
| gps_point_id | String / Null | UUID del punto GPS asociado a la orden. Puede venir en null si la orden no tiene un punto GPS relacionado. | No |
| employee_id | String / Null | UUID del empleado asignado a la orden. Puede venir en null si la orden todavía no tiene empleado asignado. | No |
| initialized_at | String / Null | Fecha y hora en la que se inició la orden. Se devuelve en formato ISO 8601. Puede venir en null si la orden aún no fue iniciada. | No |
| created_at | String | Fecha y hora en la que se creó la orden. Se devuelve en formato ISO 8601. | Si |
| updated_at | String | Fecha y hora de la última actualización de la orden. Se devuelve en formato ISO 8601. | Si |
| feedbacks_count | Integer | Cantidad de feedbacks asociados a la orden. | Si |
| programated_at | String | Fecha programada de la orden. Se devuelve en formato YYYY-MM-DD. | Si |
| zone_id | String/Null | UUID de la zona asociada a la orden. Puede venir en null si la orden no tiene zona asignada. | NO |
| need_zone_id | String / Null | UUID de la zona requerida para la orden. Puede venir en null si no aplica. | No |
| feedbacks | Array | Listado de feedbacks asociados a la orden. Puede venir vacío si la orden no tiene feedbacks cargados. | Si |
Estructura del array gps_point_attributes
| Atributo | Tipo | Descripcion | Requerido |
|---|---|---|---|
| street | String | Nombre de calle | Si |
| number | String | Numero de calle | Si |
| city | String | Nombre de ciudad | Si |
| state | String | Nombre del estado | Si |
| country | String | Nombre de pais | No |
| country_code | String | Codigo de pais, algunos ejemplos:
| No |
| additional_data | String | Comentarios adicionales de la direccion | No |
| latitude | String | Latitud | Si |
| longitude | String | Longitud | Si |
Estructura del array feedback_attributes
| Atributo | Tipo | Description | Requerido |
|---|---|---|---|
| body | String | Cuerpo del feedback | Si |
| feedback_kind_id | String | UUID del tipo de feedback | No, se pone por defecto el tipo Otro |
Filtros de búsqueda
| Atributo | Tipo | Descripción |
|---|---|---|
| status_eq | String | Busqueda por estado de la orden, los estados son los siguientes:
|
| result_eq | String | Busqueda por resultado de la orden, los resultados son los siguientes:
|
| kind_eq | String | Busqueda por tipo de orden, los tipos son los siguientes:
|
| employee_id_eq | String | Busqueda por UUID de empleado |
| start_at_gteq | Date | Busqueda por ordenes programadas para despues de la fecha, formato YYYY-MM-DD |
| end_at_lteq | Date | Busqueda por ordenes programadas para antes de la fecha, formato YYYY-MM-DD |
200
