Pular para o conteúdo principal

Listar ordens de serviço

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

Lista as ordens de serviço da conta, com paginação, filtros e ordenação. Cada ordem vem com as respostas dos campos customizados.

Requer os headers X-Api-Key e User-Agent. Limite: 1 requisição por segundo (saiba mais).

Requisição​

Parâmetros de consulta

limitinteger

Quantidade de itens por página.

De 1 a 100.Padrão: 10.

offsetinteger

Quantidade de itens a pular.

De 0 a 200000.Padrão: 0.

qstring

Filtros no formato campo:valor, separados por espaço (como filtrar). Os filtros aceitos estão na tabela abaixo.

Exemplo: customer_id:NTc4NTQ1OjIyOTE1 archived:false.

FiltroO que faz
identifier

Número da ordem de serviço, exatamente igual ao cadastrado. Até 100 caracteres.

external_id

Identificador da ordem no seu sistema (external.id). Até 100 caracteres.

customer_id

Identificador do cliente.

service_id

Identificador do tipo de OS.

ticket_id

Identificador da solicitação de serviço.

archived

true para arquivadas, false para ativas.

created_at

Data igual à informada (ISO 8601, UTC).

created_at>=

Criadas a partir da data informada, inclusive.

created_at<=

Criadas até a data informada, inclusive.

created_at>

Criadas depois da data informada.

created_at<

Criadas antes da data informada.

updated_at

Data igual à informada (ISO 8601, UTC).

updated_at>=

Alteradas a partir da data informada, inclusive.

updated_at<=

Alteradas até a data informada, inclusive.

updated_at>

Alteradas depois da data informada.

updated_at<

Alteradas antes da data informada.

sortstring

Ordenação. Prefixo - inverte a ordem.

Valores aceitos: id, created_at, -created_at, updated_at, -updated_at.Padrão: id.

Headers

User-Agentstringobrigatório

Identificação da sua aplicação.

Exemplo: MinhaIntegracao/1.0.

Respostas

  • 200

    Lista de ordens de serviço.

  • 401

    Chave de API ausente (Missing API Key) ou inválida (Invalid API Key). Ver Autenticação.

  • 403

    Conta bloqueada (Account blocked), expirada (Account expired) ou com plano que não permite integração (Account plan not allowed). Ver Autenticação.

  • 422

    Filtro, paginação ou ordenação inválidos (parametersValidationErr).

  • 429

    Limite de 1 requisição por segundo excedido. Ver Limite de requisições.

  • 500

    Erro inesperado no servidor.