Saltar al contenido principal

Listar órdenes de servicio

GEThttps://carchost.fieldcontrol.com.br/orders

Lista las órdenes de servicio de la cuenta, con paginación, filtros y ordenación. Cada orden viene con las respuestas de los campos personalizados.

Requiere los headers X-Api-Key y User-Agent. Límite: 1 solicitud por segundo (más información).

Solicitud​

Parámetros de consulta

limitinteger

Cantidad de ítems por página.

De 1 a 100.Predeterminado: 10.

offsetinteger

Cantidad de ítems que se omiten.

De 0 a 200000.Predeterminado: 0.

qstring

Filtros en el formato campo:valor, separados por espacios (cómo filtrar). Los filtros aceptados están en la tabla de abajo.

Ejemplo: customer_id:NTc4NTQ1OjIyOTE1 archived:false.

FiltroQué hace
identifier

Número de la orden de servicio, exactamente igual al registrado. Hasta 100 caracteres.

external_id

Identificador de la orden en su sistema (external.id). Hasta 100 caracteres.

customer_id

Identificador del cliente.

service_id

Identificador del tipo de orden de servicio.

ticket_id

Identificador de la solicitud de servicio.

archived

true para archivadas, false para activas.

created_at

Fecha igual a la informada (ISO 8601, UTC).

created_at>=

Creadas a partir de la fecha informada, inclusive.

created_at<=

Creadas hasta la fecha informada, inclusive.

created_at>

Creadas después de la fecha informada.

created_at<

Creadas antes de la fecha informada.

updated_at

Fecha igual a la informada (ISO 8601, UTC).

updated_at>=

Modificadas a partir de la fecha informada, inclusive.

updated_at<=

Modificadas hasta la fecha informada, inclusive.

updated_at>

Modificadas después de la fecha informada.

updated_at<

Modificadas antes de la fecha informada.

sortstring

Ordenación. El prefijo - invierte el orden.

Valores aceptados: id, created_at, -created_at, updated_at, -updated_at.Predeterminado: id.

Headers

User-Agentstringobligatorio

Identificación de su aplicación.

Ejemplo: MinhaIntegracao/1.0.

Respuestas

  • 200

    Lista de órdenes de servicio.

  • 401

    Clave de API ausente (Missing API Key) o inválida (Invalid API Key). Consulte Autenticación.

  • 403

    Cuenta bloqueada (Account blocked), vencida (Account expired) o con un plan que no permite integración (Account plan not allowed). Consulte Autenticación.

  • 422

    Filtro, paginación u ordenación inválidos (parametersValidationErr).

  • 429

    Se superó el límite de 1 solicitud por segundo. Consulte Límite de solicitudes.

  • 500

    Error inesperado en el servidor.