/orders

Atributos

Atributo

Tipo

Descripción

Requerido

id

String

UUID de la orden

Si

state

String

Estado de la orden. Los estados disponibles son:

  • pending
  • to_reschedule
  • finalized
  • closed

Si

result

String

Resultado de la orden. Los resultados posibles son:

  • not_set
  • success
  • failure

Si

kind

String

Tipo de la orden. Los estados disponibles son:

  • installation
  • technical
  • resignation
  • feasibility

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

initilialized_at

Date

Hora en la que inicio la orden

No

finalized_at

Date

Hora en la que finalizo la orden

No

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:

  • Colombia: CO
  • Argentina: AR
  • Ecuador: EC
  • Costa Rica: CR
  • Peru: PE

No

additional_data

String

Comentarios adicionales de la direccion

No

latitude

String

Latitud

Si

longitude

String

Longitud

Si

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

Atributo

Tipo

Descripción

status_eq

String

Busqueda por estado de la orden, los estados son los siguientes:

  • "pending" (pendiente)
  • "to_reschedule" (reprogramar)
  • "finalized" (finalizado)
  • "closed" (cerrado)

result_eq

String

Busqueda por resultado de la orden, los resultados son los siguientes:

  • "not_set" (sin establecer)
  • "success" (exitoso)
  • "failure" (fallido)

kind_eq

String

Busqueda por tipo de orden, los tipos son los siguientes:

  • "feasibility" (factibilidad)
  • "installation" (instalación)
  • "resignation" (baja)
  • "technical" (visita tecnica)

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

Language
Credentials
Header
Click Try It! to start a request and see the response here!