Lista o link dos planogramas das instalações ativas

GET /api/v1/planograms/export_links

Filtros

Os parâmetros abaixo podem ser passados como uma query string. Datas devem ser passadas no formato ISO 8601.

Este serviço suporta paginação.

virtual_equipment: pode ser true ou false. Se for true, apenas as boxes virtuais serão listadas.
- Caso não seja passado, é considerado false.
client_id: o id do cliente das instalações.
- Se passado, a consulta retorna somente as instalações deste cliente.
location_id: o id do local das instalações.4
- Se passado, a consulta retorna somente as instalações deste local.
machine_id: o id da máquina das instalações.
- Se passado, a consulta retorna somente as instalações com este modelo de máquina.
machine_type_id: o id do tipo de máquina das instalações.
- Se passado, a consulta retorna somente as instalações com este tipo de máquina.
equipment_id: o id do equipamento das instalações.
- Se passado, a consulta retorna somente as instalações com este equipamento.
point_of_sale: o ponto de captura das instalações.
- Se passado, a consulta retorna somente as instalações com este ponto de captura.
distribution_center_id: o id do centro de distribuição das instalações.*
connection_status_interface_kind: o tipo de conexão das instalações.
- Pode ser GPRS, WIFI ou BLUETOOTH. Se for GPRS, apenas as instalações com conexão GPRS serão listadas.
filled_inventory: percentual mínimo de estoque das instalações.
- Se passado, a consulta retorna somente as instalações com estoque acima deste percentual.
start_date: filtra instalações instaladas a partir da data informada (inclusive).
- Deve ser informado junto com o parâmetro end_date.
route_id: o id da rota das instalações.
- Se passado, a consulta retorna somente as instalações com este id de rota.
items_at_alert_level: quantidade de items com saldo abaixo do nível de alerta.
- Se passado, a consulta retorna somente as instalações que possua no mínimo a quantidade informada de items com saldo abaixo do nível de alerta.
empty_items: quantidade de items com saldo zerado.
- Se passado, a consulta retorna somente as instalações que possua no mínimo a quantidade informada de items com saldo zerado.
status: o estado das instalações.
- Se passado, a consulta retorna as instalações que possuam um estados informados,
  - red: Fora de operação
  - blue: Em alerta gerencial
  - green: Em operação
  - yellow: Parcialmente em operação
  - grey: Sem informação
tags: lista de tags das instalações.
- Se passado, a consulta retorna somente as instalações que possuam máquinas as tags informadas.

Retorno

status	descrição
200	OK

Exemplo:

[
  "installations": [
  {
      "id": 2428,
      "planogram_id": 3000,
      "planogram_url": "/api/v1/planograms/3000/export",
      "virtual_equipment": false
  },
  {
      "id": 2426,
      "planogram_id": 3001,
      "planogram_url": "/api/v1/planograms/3001/export",
      "virtual_equipment": false
  }
]

Retorna o planograma atual da instalação

GET /api/v1/planograms/[id]/export

Parâmetros de URL:

parâmetro	descrição	obrigatório
id	id do planograma	sim

Retorno

status	descrição
200	OK

Exemplo:

{
  "client": "Cliente 1",
  "location": "Local 1",
  "machine": "2016-01-26T17:36:44.000-02:00",
  "box": "0000000 (111111111)"",
  "route": "Rota 1",
  "machine_type": "Micromarket",
  "created_at": "05/07/2023",
  "started_at": "01/07/2023",
  "items": [
    {
      "name": "1",
      "upc_code": "10",
      "good": "Produto 10",
      "status": "active",
      "capacity": 20,
      "par_level": 20,
      "alert_level": 4,
      "desired_price": 2.0,
      "current_balance": 10.0,
      "missing": 0.0
    },
    {
      "name": "2",
      "upc_code": "20",
      "good": "Produto 20",
      "status": "active",
      "capacity": 20,
      "par_level": 20,
      "alert_level": 4,
      "desired_price": 3.0,
      "current_balance": 10.0,
      "missing": 0.0
    },
    {
      "name": "3",
      "upc_code": "30",
      "good": "Produto 30",
      "status": "active",
      "capacity": 30,
      "par_level": 20,
      "alert_level": 4,
      "desired_price": 4.0,
      "current_balance": 10.0,
      "missing": 0.0
    }
  ]
}

Erros

status	descrição	response body
404	planograma não encontrado	{ “status”: “404”, “error”: “Not Found” }