Pular para o conteúdo principal

Listar peças

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

Lista as peças da conta, com paginação, filtros e ordenação. A listagem não inclui equipmentTypes nem customFields.

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: code:CAP archived:false.

FiltroO que faz
name

Parte do nome da peça, sem diferenciar maiúsculas e minúsculas.

code

Parte do código da peça, sem diferenciar maiúsculas e minúsculas.

externalId

Identificador da peça no seu sistema, exatamente igual ao cadastrado.

partTypeId

Identificador do tipo de peça.

archived

true para arquivadas, false para ativas.

sortstring

Ordenação. Prefixo - inverte a ordem.

Valores aceitos: id, -id, name, -name, code, -code, value, -value, 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 peças.

  • 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

    Paginação ou ordenação inválidas (parametersValidationErr).

  • 429

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

  • 500

    Erro inesperado no servidor.