Fulfillment - Manual da API
  1. Locais de Estoque
Fulfillment - Manual da API
  • 🚀 Introdução
  • 🔒 Autenticação
  • 🚦 Rate Limiting
  • 🛟 Suporte
  • Autenticação
    • Autenticação
    • Sessão do usuário
    • Refresh Token
    • Finalizar Sessão
  • Produtos
    • 📦 Conceitos de Produtos
    • Gerenciamento
      • Coleção de produtos
      • Criar um novo produto
      • Detalhes do produto
      • Estoque do Produto
      • Modificar Produto
      • Excluir Produto
    • Controle
      • Controle de Temperatura
      • Controle de Estoque
      • Data de validade & Lote
    • Códigos fiscais
      • Códigos fiscais do produto
      • Adicionar um código fiscal no produto
      • Detalhes do código fiscal do produto
      • Modificar código fiscal do produto
      • Excluir código fiscal do produto
  • Tipos de Operações
    • ♻️ Tipos de Operação
    • 📦 Entrada de Mercadoria
    • Tipos de Operações
    • Tipo de Operação
  • Clientes
    • 👔 Clientes & Parceiros
    • Gerenciamento
      • Coleção de Clientes
      • Novo cliente
      • Detalhes
      • Modificar
      • Excluir
    • Endereços
      • Endereços
      • Adicionar Endereço
      • Detalhes do Endereço
      • Modificar Endereço
  • Pedidos
    • 🛒 Pedidos Fulfillment
    • Gerenciamento
      • Pedidos
      • Novo Pedido
      • Detalhes do Pedido
      • Confirmar Pedido
      • Update Order
    • Workflows
      • Situação atual de um pedido
      • Fluxos de execução disponíveis
      • Avançar Workflow
      • Cancelar Pedido / Workflow
    • Itens do Pedido
      • Gerenciamento
        • Itens do Pedido
        • Adicionar Item
        • Detalhes do Item
        • Modificar Item
        • Excluir Item
      • Rastreamento
        • Rastreamentos
        • Adicionar Rastreamento
        • Detalhes do Rastreamento
        • Excluir Rastreamento
    • Agendamento
      • Agendamento
      • Slots Disponíveis
      • Reservar Slots
      • Cancelar Agendamento
      • Confirmar Agendamento
    • Identificação de Produtos
      • Etiquetas
      • Gerar Etiquetas
      • Confirmar impressão
    • Documentos Fiscais
      • Documentos Fiscais
      • Documento Fiscal
      • Detalhes do Documento
      • Excluir Documento
    • Documentos para Impressão
      • Documentos
      • Adicionar Documento
      • Detalhes do Documento
      • Pré-visualização
      • Excluir Documento
  • Configurações
    • Webhooks
      • Webhooks
      • Webhook
      • Webhook
      • Webhook
      • Webhook
      • Histórico
      • Estatísticas
      • Teste
      • Eventos Disponíveis
    • Integrações
      • Faturador - Bling
        • Integrações
        • Criar Integração
        • Detalhes da Integração
        • Cancelar Integração
        • Status da Integração
        • Logs
        • Auth Link
    • Enumeração
      • Enumeração
      • Tipos disponíveis
    • Token de API
      • Token de API
      • Criar um novo Token
  • Fiscal
    • Pedidos aguardando nota fiscal
    • Totais - aguardando nota fiscal
  • Locais de Estoque
    • Localizações Exclusivas
      GET
    • Ocupação das Localizações
      GET
    • Detalhes de uma Localização
      GET
    • Produtos de uma Localização
      GET
  • Inventário
    • Resumo Geral do Estoque
    • Inventário Detalhado
    • Produtos com Estoque Baixo
    • Consulta Detalhada de Estoque
  1. Locais de Estoque

Detalhes de uma Localização

GET
/api/v1/locations/{location_code}
Retorna as informações completas de uma localização específica pertencente ao cliente, incluindo dados de identificação, tipo, status de ocupação, capacidade (volume e peso), produtos armazenados, configuração operacional, hierarquia da estrutura (depósito, zona, rua, prédio, etc.).

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Path Params

Responses

🟢200OK
application/json
Body

Example
{
    "success": true,
    "message": "Detalhes da localização recuperados com sucesso",
    "data": {
        "name": "L1-1",
        "code": "01.05.01.01.01.01",
        "barcode": "01.05.01.01.01.01",
        "barcode_128": "19246924",
        "type": {
            "value": "SHELF",
            "label": "Prateleira"
        },
        "status": {
            "value": "occupied",
            "label": "Ocupado"
        },
        "dimensions": {
            "width": "600.00",
            "height": "400.00",
            "depth": "400.00",
            "volume": "96000.000",
            "weight_capacity": "20000.000",
            "horizontal_position": 1
        },
        "capacity": {
            "volume": {
                "total": "96000.000",
                "occupied": "22500.000",
                "available": 73500,
                "occupancy_rate": 23.44
            },
            "weight": {
                "total": "20000.000",
                "occupied": "4.500",
                "available": 19995.5,
                "occupancy_rate": 0.02
            }
        },
        "occupancy_status": {
            "status": "low",
            "label": "Baixa ocupação",
            "color": "green",
            "description": "Bastante espaço disponível"
        },
        "operational_config": {
            "is_exclusive": true,
            "sale_availability": {
                "is_available": false,
                "status": "storage_only",
                "label": "Apenas Armazenamento",
                "description": "Esta localização é usada exclusivamente para armazenamento, não para vendas",
                "color": "blue",
                "icon": "warehouse"
            },
            "can_store_inventory": true,
            "can_pick_orders": false,
            "is_special_location": false,
            "location_purpose": {
                "type": "dedicated",
                "label": "Localização Dedicada",
                "description": "Reservada exclusivamente para este cliente"
            }
        },
        "products": {
            "total_products": 15,
            "unique_products": 1,
            "total_quantity": 15,
            "reserved_quantity": 0,
            "available_quantity": 15,
            "products_summary": [
                {
                    "name": "Smartphone Galaxy Pro 256GB",
                    "sku": "ELET-SMART-001",
                    "total_quantity": 15,
                    "reserved_quantity": 0,
                    "available_quantity": 15,
                    "batches_count": 0,
                    "has_expiration": false,
                    "earliest_expiration": null
                }
            ],
            "expiring_soon": []
        },
        "location_hierarchy": {
            "location": {
                "name": "L1-1",
                "code": "01.05.01.01.01.01"
            },
            "level": {
                "name": "Nível 1",
                "code": "01.05.01.01.01"
            },
            "building": {
                "name": "Torre 1",
                "code": "01.05.01.01"
            },
            "street": {
                "name": "01.05.01 (Left)",
                "code": "01.05.01"
            },
            "zone": {
                "name": "Mezanino",
                "code": "01.05",
                "type": "storage"
            },
            "warehouse": {
                "name": "001 - Pari - SP",
                "code": "001",
                "type": "fulfillment"
            }
        },
        "description": "Localização para armazenamento de caixas - Lado Esquerdo",
        "is_active": true,
        "audit": {
            "created_at": "2025-07-21T18:18:44.000000Z",
            "updated_at": "2025-07-21T20:12:23.000000Z"
        }
    }
}
Previous
Ocupação das Localizações
Next
Produtos de uma Localização
Built with