Seleções Disponíveis

Listar

GET /api/v1/available_selections

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.

client_id: o id do cliente do local da instalação.
- Se passado, a consulta retorna somente seleções disponíveis, geradas por esse cliente.
location_id: o id do local da instalação.
- Se passado, a consulta retorna somente seleções disponíveis, geradas nesse local.
machine_id: o id da máquina da instalação.
- Se passado, a consulta retorna somente seleções disponíveis, geradas nesta máquina.
machine_model_id: o id do modelo da máquina, pertencente à respectiva instalação.
- Se passado, a consulta retorna somente seleções disponíveis, geradas neste modelo.
machine_type_id: o id do tipo de máquina, do modelo de máquina, da respectiva instalação.
- Se passado, a consulta retorna somente seleções disponíveis, geradas neste tipo de máquina.
machine_category_id: o id da categoria, do tipo de máquina, da respectiva instalação.
- Se passado, a consulta retorna somente seleções disponíveis, geradas nesta categoria.
distribution_center_id: o id do centro de distribuição, da maquina pertencente à instalação.
- Se passado, a consulta retorna somente seleções disponíveis, ocorridas nas instalações do centro de distribuição.
good_id: o id do produto vinculado aos items do planograma.
- Se passado, a consulta retorna somente seleções disponíveis que contém esse produto.
category_id: o id da categoria do produto vinculado aos items do planograma.
- Se passado, a consulta retorna somente seleções disponíveis, que contém essa categoria.
product_type: um booleano, indicando se o produto vinculado aos items do planograma é ou não fracionável.
tags: as tags associadas aos produtos ou máquinas das seleções disponíveis.
- Se passado, a consulta retorna somente as seleções disponíveis, cujas máquinas ou produtos contém as tags passadas.
status: indica qual o status que deseja consultar, podendo ser um desses valores:
- active: o item está ativo e disponível para uso no vmpay e para venda
- inactive: o item está inativo e não poderá ser usado no vmpay nem disponibilizado para venda
- suspended o item está suspenso e não poderá ser usado no vmpay, mas as unidades em campo poderão ser vendidas

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:

client: id e nome do cliente.
location: o id e nome do local.
machine: o id e número de fábrica da máquina.
machine_model: o id e nome do modelo da máquina
machine_type: o id e nome do tipo da máquina do modelo da máquina.
distribution_center: id e nome do centro de distribuição.
physical_locators: número da canaleta do item.
good: o id, nome e upc_code do produto associado ao item do planograma.
status: o status atual do item.
capacity: a capacidade da canaleta.
par_level: nível de par.
alert_level: o nível de alerta da canaleta.
desired_price: o preço unitário desejado.
inventory_balance: o valor do item do planograma

Segue um exemplo de retorno de consulta:

[
    {
        "client": {
            "id": 8971,
            "name": "Cliente"
        },
        "location": {
            "id": 8512,
            "name": "Cliente Tecnologia"
        },
        "machine": {
            "id": 6789,
            "asset_number": "0005"
        },
        "machine_model": {
            "id": 157,
            "name": "Micromarket"
        },
        "machine_type": {
            "id": 8974,
            "name": "Micromarket"
        },
        "distribution_center": {
            "id": 100,
            "name": "Padrão"
        },
        "physical_locators": [
            "1"
        ],
        "good": {
            "id": 78541,
            "display_name": "LARANJA 300ML",
            "upc_code": "000000000002084702"
        },
        "status": "active",
        "capacity": 50.0,
        "par_level": 50.0,
        "alert_level": 40.0,
        "desired_price": 6.5,
        "inventory_balance": 100.0
    }
]

Ver

GET /api/v1/available_selections?access_token=QwRT89RQYcvr89&client_id=7895&location_id=05&machine_id=12
  &good_id=789&machine_model_id=147&machine_type_id=106&machine_category_id=5&distribution_center_id=104
      &product_type=false&use_cost_price=true&tags[]=tag1&tags[]=tag2

Parâmetros de URL:

parâmetro	descrição	obrigatório
access_token	chave de operador	sim
client_id	id do cliente	não
location_id	id da localização	não
machine_id	id da máquina	não
good_id	id do produto	não
machine_model_id	id do modelo de máquina	não
machine_type_id	id do tipo de máquina	não
machine_category_id	id da categoria da máquina	não
distribution_center_id	id do centro de distribuição	não
product_type	booleano para tipo de produto	não
use_cost_price	booleano para preço de custo	não
tags[]	tags associadas	não

Retorno

status	descrição
200	OK

Exemplo:

[
    {
        "client": {
            "id": 7895,
            "name": "Cliente virtual"
        },
        "location": {
            "id": 05,
            "name": "Cliente Tecnologia"
        },
        "machine": {
            "id": 12,
            "asset_number": "0005"
        },
        "machine_model": {
            "id": 147,
            "name": "Micromarket"
        },
        "machine_type": {
            "id": 106,
            "name": "Micromarket"
        },
        "distribution_center": {
            "id": 104,
            "name": "Padrão"
        },
        "physical_locators": [
            "1"
        ],
        "good": {
            "id": 789,
            "display_name": "NATURAL 300ML",
            "upc_code": "000000000002027702"
        },
        "status": "active",
        "capacity": 50.0,
        "par_level": 50.0,
        "alert_level": 40.0,
        "cost_price": 2.0,
        "inventory_balance": 100.0
    }
]

Erros

status

descrição

response body

422

ao fazer a consulta, filtro de tag inválida

{ “error”: “Tags precisa ser do tipo array” }