Inventário Detalhado

Retorna os registros únicos de inventário armazenados por produto e localização, considerando os diferentes critérios de controle como número de série, lote ou validade.

Cada registro representa uma unidade de controle distinta:

Produto: nome, SKU, código de barras

Estoque consolidado: quantidade total, reservada, disponível e disponível para venda

Localizações: dados da localização física e a quantidade presente naquele local

A resposta inclui metadados que indicam a chave do cache gerada com base nos parâmetros da requisição, bem como o horário de expiração dos dados:

"meta": {
   "cache_key": "stock_query_b9eba8de51989be872335b70ca1fdf38",
   "cache_expires_at": "2025-07-21T17:55:17-03:00"
}

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Responses

🟢200OK

application/json

Body

Example

{
    "success": true,
    "message": "Estoque recuperado com sucesso",
    "data": [
        {
            "product": {
                "name": "Smartphone Galaxy Pro 256GB",
                "sku": "ELET-SMART-001",
                "barcode": "ELET-SMART-001-121927",
                "min_stock_quantity": 5,
                "ideal_stock_quantity": 15
            },
            "stock": {
                "total_quantity": 15,
                "reserved_quantity": 0,
                "available_quantity": 15,
                "available_for_sale": 15,
                "is_below_min": false
            },
            "locations": [
                {
                    "location_code": "01.05.01.01.01.01",
                    "location_name": "L1-1",
                    "quantity": 1,
                    "quantity_reserved": 0,
                    "available": 1,
                    "available_for_sale": 1,
                    "serial_number": "SMART2024-0001",
                    "batch_number": null,
                    "is_available_for_sale": true
                },
                {
                    "location_code": "01.05.01.01.01.01",
                    "location_name": "L1-1",
                    "quantity": 1,
                    "quantity_reserved": 0,
                    "available": 1,
                    "available_for_sale": 1,
                    "serial_number": "SMART2024-0002",
                    "batch_number": null,
                    "is_available_for_sale": true
                },
                {
                    "location_code": "01.05.01.01.01.01",
                    "location_name": "L1-1",
                    "quantity": 1,
                    "quantity_reserved": 0,
                    "available": 1,
                    "available_for_sale": 1,
                    "serial_number": "SMART2024-0003",
                    "batch_number": null,
                    "is_available_for_sale": true
                },
                {
                    "location_code": "01.05.01.01.01.01",
                    "location_name": "L1-1",
                    "quantity": 1,
                    "quantity_reserved": 0,
                    "available": 1,
                    "available_for_sale": 1,
                    "serial_number": "SMART2024-0004",
                    "batch_number": null,
                    "is_available_for_sale": true
                },
                {
                    "location_code": "01.05.01.01.01.01",
                    "location_name": "L1-1",
                    "quantity": 1,
                    "quantity_reserved": 0,
                    "available": 1,
                    "available_for_sale": 1,
                    "serial_number": "SMART2024-0005",
                    "batch_number": null,
                    "is_available_for_sale": true
                },
                {
                    "location_code": "01.05.01.01.01.01",
                    "location_name": "L1-1",
                    "quantity": 1,
                    "quantity_reserved": 0,
                    "available": 1,
                    "available_for_sale": 1,
                    "serial_number": "SMART2024-0006",
                    "batch_number": null,
                    "is_available_for_sale": true
                },
                {
                    "location_code": "01.05.01.01.01.01",
                    "location_name": "L1-1",
                    "quantity": 1,
                    "quantity_reserved": 0,
                    "available": 1,
                    "available_for_sale": 1,
                    "serial_number": "SMART2024-0007",
                    "batch_number": null,
                    "is_available_for_sale": true
                },
                {
                    "location_code": "01.05.01.01.01.01",
                    "location_name": "L1-1",
                    "quantity": 1,
                    "quantity_reserved": 0,
                    "available": 1,
                    "available_for_sale": 1,
                    "serial_number": "SMART2024-0008",
                    "batch_number": null,
                    "is_available_for_sale": true
                },
                {
                    "location_code": "01.05.01.01.01.01",
                    "location_name": "L1-1",
                    "quantity": 1,
                    "quantity_reserved": 0,
                    "available": 1,
                    "available_for_sale": 1,
                    "serial_number": "SMART2024-0009",
                    "batch_number": null,
                    "is_available_for_sale": true
                },
                {
                    "location_code": "01.05.01.01.01.01",
                    "location_name": "L1-1",
                    "quantity": 1,
                    "quantity_reserved": 0,
                    "available": 1,
                    "available_for_sale": 1,
                    "serial_number": "SMART2024-0010",
                    "batch_number": null,
                    "is_available_for_sale": true
                },
                {
                    "location_code": "01.05.01.01.01.01",
                    "location_name": "L1-1",
                    "quantity": 1,
                    "quantity_reserved": 0,
                    "available": 1,
                    "available_for_sale": 1,
                    "serial_number": "SMART2024-0011",
                    "batch_number": null,
                    "is_available_for_sale": true
                },
                {
                    "location_code": "01.05.01.01.01.01",
                    "location_name": "L1-1",
                    "quantity": 1,
                    "quantity_reserved": 0,
                    "available": 1,
                    "available_for_sale": 1,
                    "serial_number": "SMART2024-0012",
                    "batch_number": null,
                    "is_available_for_sale": true
                },
                {
                    "location_code": "01.05.01.01.01.01",
                    "location_name": "L1-1",
                    "quantity": 1,
                    "quantity_reserved": 0,
                    "available": 1,
                    "available_for_sale": 1,
                    "serial_number": "SMART2024-0013",
                    "batch_number": null,
                    "is_available_for_sale": true
                },
                {
                    "location_code": "01.05.01.01.01.01",
                    "location_name": "L1-1",
                    "quantity": 1,
                    "quantity_reserved": 0,
                    "available": 1,
                    "available_for_sale": 1,
                    "serial_number": "SMART2024-0014",
                    "batch_number": null,
                    "is_available_for_sale": true
                },
                {
                    "location_code": "01.05.01.01.01.01",
                    "location_name": "L1-1",
                    "quantity": 1,
                    "quantity_reserved": 0,
                    "available": 1,
                    "available_for_sale": 1,
                    "serial_number": "SMART2024-0015",
                    "batch_number": null,
                    "is_available_for_sale": true
                }
            ]
        }
    ],
    "meta": {
        "cache_key": "stock_query_b9eba8de51989be872335b70ca1fdf38",
        "cache_expires_at": "2025-07-21T17:55:17-03:00"
    }
}

Request

Responses