/orders

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Atributos

AtributoTipoDescripciónRequerido
idStringUUID de la ordenSi
stateStringEstado de la orden. Los estados disponibles son:
  • pending
  • to_reschedule
  • finalized
  • closed
Si
resultStringResultado de la orden. Los resultados posibles son:
  • not_set
  • success
  • failure
Si
kindStringTipo de la orden. Los estados disponibles son:
  • installation
  • technical
  • resignation
  • feasibility
Si
descriptionStringDescripción de la ordenNo
parent_order_idStringUUID de la orden padreNo
ticketable_idStringUUID del ticket de mesa o ventaNo
ticketable_typeStringTipo de ticket (HelpDesk/SaleDesk)No
orderable_idStringUUID del contrato o prospectoNo
orderable_typeStringTipo de contrato (Contract/Prospect)No
start_atDateHora programada para el inicio de la ordenNo
end_atDateHora programada para el fin de la ordenNo
initialized_atDateHora en la que inicio la ordenNo
finalized_atDateHora en la que finalizo la ordenNo
statusIntegerCódigo de estado de la respuesta. Ejemplo: 200.Si
metaObjectObjeto que contiene información general de la respuesta.Si
meta.objectStringTipo de objeto devuelto por la API. Para este endpoint devuelve order.Si
meta.paginationObjectObjeto que contiene información de paginación del listado.Si
meta.pagination.total_recordsIntegerCantidad total de registros encontrados para la consulta realizada.Si
meta.pagination.total_pagesIntegerCantidad total de páginas disponibles según la cantidad de registros y el límite por página.Si
meta.pagination.per_pageIntegerCantidad de registros devueltos por página.Si
meta.pagination.current_pageIntegerNúmero de página actual devuelta por la API.Si
dataArrayListado de órdenes devueltas por la API. Cada elemento del array corresponde a una orden.Si
sequential_idIntegerIdentificador secuencial de la orden.Si
isp_idStringUUID del ISP asociado a la orden.Si
gps_point_idString / NullUUID del punto GPS asociado a la orden. Puede venir en null si la orden no tiene un punto GPS relacionado.No
employee_idString / NullUUID del empleado asignado a la orden. Puede venir en null si la orden todavía no tiene empleado asignado.No
initialized_atString / NullFecha 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_atStringFecha y hora en la que se creó la orden. Se devuelve en formato ISO 8601.Si
updated_atStringFecha y hora de la última actualización de la orden. Se devuelve en formato ISO 8601.Si
feedbacks_countIntegerCantidad de feedbacks asociados a la orden.Si
programated_atStringFecha programada de la orden. Se devuelve en formato YYYY-MM-DD.Si
zone_idString/NullUUID de la zona asociada a la orden. Puede venir en null si la orden no tiene zona asignada.NO
need_zone_idString / NullUUID de la zona requerida para la orden. Puede venir en null si no aplica.No
feedbacksArrayListado de feedbacks asociados a la orden. Puede venir vacío si la orden no tiene feedbacks cargados.Si

Estructura del array gps_point_attributes

AtributoTipoDescripcionRequerido
streetStringNombre de calleSi
numberStringNumero de calleSi
cityStringNombre de ciudadSi
stateStringNombre del estadoSi
countryStringNombre de paisNo
country_codeStringCodigo de pais, algunos ejemplos:
  • Colombia: CO
  • Argentina: AR
  • Ecuador: EC
  • Costa Rica: CR
  • Peru: PE
No
additional_dataStringComentarios adicionales de la direccionNo
latitudeStringLatitudSi
longitudeStringLongitudSi

Estructura del array feedback_attributes

AtributoTipoDescriptionRequerido
bodyStringCuerpo del feedbackSi
feedback_kind_idStringUUID del tipo de feedbackNo, se pone por defecto el tipo Otro

Filtros de búsqueda

AtributoTipoDescripción
status_eqStringBusqueda por estado de la orden, los estados son los siguientes:
  • "pending" (pendiente)
  • "to_reschedule" (reprogramar)
  • "finalized" (finalizado)
  • "closed" (cerrado)
result_eqStringBusqueda por resultado de la orden, los resultados son los siguientes:
  • "not_set" (sin establecer)
  • "success" (exitoso)
  • "failure" (fallido)
kind_eqStringBusqueda por tipo de orden, los tipos son los siguientes:
  • "feasibility" (factibilidad)
  • "installation" (instalación)
  • "resignation" (baja)
  • "technical" (visita tecnica)
employee_id_eqStringBusqueda por UUID de empleado
start_at_gteqDateBusqueda por ordenes programadas para despues de la fecha, formato YYYY-MM-DD
end_at_lteqDateBusqueda por ordenes programadas para antes de la fecha, formato YYYY-MM-DD

Query Params
string
enum
Allowed:
string
enum
Allowed:
string
enum
Allowed:
string
date
date
Response
200
Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here!