Pular para o conteúdo principal

Listar movimentações

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

Lista as movimentações de estoque da conta (entradas e saídas), com paginação, filtros e ordenação. Uma transferência aparece como uma saída e uma entrada. 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: storage_id:MWY5ZGE5YzgtZDY3MC00NWJhLTk0MGUtNzQxYjk3ODI0MzllOjIyOTE1 type:entry.

FiltroO que faz
storage_id

Identificador do depósito.

product_id

Identificador do produto.

order_id

Identificador da ordem de serviço.

type

entry ou removal.

created_at

Data igual à informada (ISO 8601, UTC).

created_at>=

Feitas a partir da data informada, inclusive.

created_at<=

Feitas até a data informada, inclusive.

created_at>

Feitas depois da data informada.

created_at<

Feitas antes da data informada.

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 movimentações.

  • 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.