Listar depósitos

GEThttps://carchost.fieldcontrol.com.br/storages-v2

Lista os depósitos da conta, com paginação, filtros e ordenação. A listagem não inclui storageProducts. Requer o módulo de controle de estoque.

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: name:central archived:false.

Filtro	O que faz
name	Parte do nome do depósito, sem diferenciar maiúsculas e minúsculas. Até 50 caracteres.
name_eq	Nome do depósito, exatamente igual ao cadastrado. Até 50 caracteres.
description	Parte da descrição, sem diferenciar maiúsculas e minúsculas. Até 100 caracteres.
employee_id	Identificador do colaborador responsável.
archived	true para arquivados, false para ativos.

sortstring

Ordenação. Prefixo - inverte a ordem.

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

Headers

User-Agentstringobrigatório

Identificação da sua aplicação.

Exemplo: MinhaIntegracao/1.0.

Respostas

• 200

  Lista de depósitos.

• 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). Conta sem o módulo de controle de estoque: resourceNotAllowed.

• 429

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

• 500

  Erro inesperado no servidor.