Movimentos dos Centros de Estoque

Listar

GET /api/v1/distribution_center_inventories

Observação

API não disponível para operadores que utilizam integração com ERP Interno da VMtecnologia

Filtros

Os parâmetros abaixo podem ser passados como uma query string. Mais de um filtro pode ser passado na mesma consulta.

Este serviço suporta paginação.

occurred_at_start: a data de início da movimentação.
- A consulta retorna somente movimentos gerados a partir desta data e hora, inclusive.
- Este filtro é obrigatório. Se não for passado, será retornado erro com o código HTTP 400 (bad request).
- Se o formato da data for inválido, será retornado erro com o código HTTP 400 (bad request).
- Se a data for maior que a do filtro end_date, será retornado erro com o código HTTP 400 (bad request).
- Se a data for menor que 30 dias antes da data do filtro end_date, será retornado erro com o código HTTP 400 (bad request).
- Deve-se passar a data e também a hora; se não for passada, será considerado 00:00:00 UTC.
- Os segundos passados na hora são desconsiderados. O sistema considera sempre 00.
- Um formato possível é dd/mm/yyyy hh:mi. Nesse caso a data e hora devem estar em UTC.
- Este filtro também suporta o formato ISO 8601.
occurred_at_end: a data final da movimentação.
- A consulta retorna somente movimentos gerados até esta data e hora, inclusive.
- Este filtro é obrigatório. Se não for passado, será retornado erro com o código HTTP 400 (bad request).
- Se o formato da data for inválido, será retornado erro com o código HTTP 400 (bad request).
- Se a data for menor que a do filtro start_date, será retornado erro com o código HTTP 400 (bad request).
- Se a data for maior que 30 dias depois da data do filtro start_date, será retornado erro com o código HTTP 400 (bad request).
- Deve-se passar a data e também a hora; se não for passada, será considerado 23:59:59 UTC.
- Os segundos passados na hora são desconsiderados. O sistema considera sempre 59.
- Um formato possível é dd/mm/yyyy hh:mi. Nesse caso a data e hora devem estar em UTC.
- Este filtro também suporta o formato ISO 8601.
provider_id: o id do fornecedor. Se passado, a consulta retorna somente movimentos com o fornecedor informado.
kind: o tipo de movimento. Se passado, a consulta retorna somente movimentações com o tipo informado.
- StorableEntry: Entrada de estoque
- StorableAdjustment: Ajuste de estoque
- PlanogramAssignment: Alteração de planograma
- Good: Produto
- Visit: Visita
good_id: o id da produto. Se passado, a consulta retorna somente movimentações com o produto informado.
distribution_center_id: o id do centro de distribuição. Se passado, a consulta retorna somente movimentações com o centro de distribuição informado.

Retorno

É retornado um JSON contendo um array com objetos que correspondem às visitas. O array é ordenado por data e hora de geração da nota fiscal, da mais recente para a mais antiga. Os campos de cada nota fiscal são os seguintes:

id: o id do momvimento
occurred_at: a data e hora do movimento, no formato ISO 8601.
balance_before: o saldo antes do movimento.
value: o valor do movimento.
balance_after: o saldo após o movimento.
originator_type: o tipo de movimento (kind).
cost_price: o custo do produto.
total_cost_price: o custo total do produto.
number: o número da nota fiscal.
nature_operation: a natureza da operação.
distribution_center: id e nome do centro de distribuição.
good: id, nome e código de barras do produto.

Segue um exemplo de retorno de consulta:

[
  {
    "id": 687194321,
    "occurred_at": "2021-11-06T12:00:00.000Z",
    "balance_before": 2.5,
    "value": 1.5,
    "balance_after": 4,
    "distribution_center": {
      "id": 733096098,
      "name": "Padrão"
    },
    "good": {
      "id": 543551105,
      "display_name": "Fanta",
      "barcode": "7894900010010"
    },
    "originator_type": "StorableEntry",
    "cost_price": 1.5,
    "total_cost_price": 1.5,
    "number": "1",
    "nature_operation": "purchase"
  }
]