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

Localizações Exclusivas

GET
/api/v1/locations
Retorna as localizações exclusivas associadas ao usuário autenticado, incluindo informações sobre disponibilidade para venda, status de ocupação, dimensões, capacidade e outras configurações operacionais.

Request

Authorization
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": "Localizações recuperadas com sucesso",
    "search_query": "",
    "filters": [],
    "pagination": {
        "page": 1,
        "per_page": 15,
        "last_page": 1,
        "has_prev_page": false,
        "has_next_page": false,
        "records": {
            "from": 1,
            "to": 1,
            "total": 1
        }
    },
    "data": [
        {
            "name": "L1-1",
            "code": "01.05.01.01.01.01",
            "barcode": "01.05.01.01.01.01",
            "type": {
                "value": "SHELF",
                "label": "Prateleira"
            },
            "status": {
                "value": "occupied",
                "label": "Ocupado"
            },
            "dimensions": {
                "width": "600.00",
                "height": "400.00",
                "depth": "400.00",
                "volume": "96000.000"
            },
            "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"
            },
            "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_pick_orders": false
            },
            "inventory_summary": {
                "has_products": true,
                "unique_products_count": 1,
                "total_items": 15
            },
            "zone": {
                "name": "Mezanino",
                "code": "01.05"
            },
            "is_active": true,
            "created_at": "2025-07-21T18:18:44.000000Z",
            "updated_at": "2025-07-21T19:25:29.000000Z"
        }
    ]
}
Previous
Totais - aguardando nota fiscal
Next
Ocupação das Localizações
Built with