Fulfillment - Manual da API
  1. Gerenciamento
Fulfillment - Manual da API
  • 🚀 Introdução
  • 🔒 Autenticação
  • 🚦 Rate Limiting
  • Autenticação
    • Autenticação
    • Sessão do usuário
    • Refresh Token
    • Finalizar Sessão
  • Produtos
    • 📦 Conceitos de Produtos
    • Gerenciamento
      • Coleção de produtos
        GET
      • Criar um novo produto
        POST
      • Detalhes do produto
        GET
      • Estoque do Produto
        GET
      • Modificar Produto
        PUT
      • Excluir Produto
        DELETE
    • Controle
      • Controle de Temperatura
        PUT
      • Controle de Estoque
        PUT
      • Data de validade & Lote
        PUT
    • Códigos fiscais
      • Códigos Fiscais de Produtos
      • Códigos fiscais
        GET
      • Código fiscal
        POST
      • Código fiscal
        GET
      • Código fiscal
        PUT
      • Código fiscal
        DELETE
    • RMA
      • Estatísticas
        GET
      • Qualidade
        GET
      • Ocorrências
        GET
  • 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 - Gerenciamento
    • 🛒 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
  • Pedidos - Aguardando NFe
    • Totais
    • Aguardando NFe
    • Detalhes Fiscal
  • Configurações
    • Webhooks
      • Webhooks
      • Webhook
      • Webhook
      • Webhook
      • Webhook
      • Histórico
      • Estatísticas
      • Teste
      • Eventos Disponíveis
    • Enumeração
      • Enumeração
      • Tipos disponíveis
    • Token de API
      • Token de API
      • Criar um novo Token
  • Locais de Estoque
    • Localizações Exclusivas
    • Ocupação das Localizações
    • Detalhes de uma Localização
    • Produtos de uma Localização
  • Inventário
    • Resumo Geral do Estoque
    • Inventário Detalhado
    • Produtos com Estoque Baixo
    • Consulta Detalhada de Estoque
  1. Gerenciamento

Coleção de produtos

Developing
GET
/api/v1/products
Last modified:2025-09-05 14:55:46

Request

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

Header Params

Responses

🟢200OK
application/json
Body

Example
{
    "success": true,
    "message": "Produtos listados com sucesso",
    "search_query": "",
    "filters": {
        "product_type": "finished_good"
    },
    "pagination": {
        "page": 1,
        "per_page": 15,
        "last_page": 1,
        "has_prev_page": false,
        "has_next_page": false,
        "records": {
            "from": 1,
            "to": 6,
            "total": 6
        }
    },
    "data": [
        {
            "sku": "CADEIRA-ERG-001",
            "name": "Cadeira Ergonômica",
            "description": "Cadeira ergonômica para escritório",
            "unit_cost": 299.9,
            "unit": "un",
            "product_type": "finished_good",
            "barcode": "CADEIRA-ERG-001-083590",
            "is_active": true,
            "dimensions": {
                "height": 10,
                "width": 6,
                "length": 6,
                "weight": 12
            },
            "dimensions_description": "10.0cm (A) × 6.0cm (L) × 6.0cm (C) | 12.000kg",
            "characteristics": {
                "is_dangerous": false,
                "is_fragile": false,
                "has_serial_number": false,
                "has_batch_control": false,
                "has_ean": false
            },
            "stock_control": {
                "restock_priority": 2,
                "restock_priority_description": "Média",
                "min_stock_quantity": 5,
                "ideal_stock_quantity": 20
            },
            "expiration_control": {
                "has_expiration_date": false,
                "shelf_life_days": null,
                "min_remaining_shelf_life": null,
                "expiration_alert_days": null
            },
            "temperature_control": {
                "is_refrigerated": false,
                "storage_temp_min": null,
                "storage_temp_max": null
            },
            "created_at": "2025-09-05T14:46:30.000000Z",
            "updated_at": "2025-09-05T14:46:30.000000Z"
        },
        {
            "sku": "FITA-AD-001",
            "name": "Fita Adesiva Transparente 45mm x 50m",
            "description": "Fita adesiva transparente para embalagem",
            "unit_cost": 2.45,
            "unit": "un",
            "product_type": "finished_good",
            "barcode": "FITA-AD-001-083590",
            "is_active": true,
            "dimensions": {
                "height": 0.5,
                "width": 0.6,
                "length": 0.6,
                "weight": 0.15
            },
            "dimensions_description": "0.5cm (A) × 0.6cm (L) × 0.6cm (C) | 0.150kg",
            "characteristics": {
                "is_dangerous": false,
                "is_fragile": false,
                "has_serial_number": false,
                "has_batch_control": false,
                "has_ean": false
            },
            "stock_control": {
                "restock_priority": 3,
                "restock_priority_description": "Alta",
                "min_stock_quantity": 30,
                "ideal_stock_quantity": 100
            },
            "expiration_control": {
                "has_expiration_date": false,
                "shelf_life_days": null,
                "min_remaining_shelf_life": null,
                "expiration_alert_days": null
            },
            "temperature_control": {
                "is_refrigerated": false,
                "storage_temp_min": null,
                "storage_temp_max": null
            },
            "created_at": "2025-09-05T14:46:30.000000Z",
            "updated_at": "2025-09-05T14:46:30.000000Z"
        },
        {
            "sku": "PAPEL-A4-CX10",
            "name": "Papel Sulfite A4 75g (Caixa 10 resmas)",
            "description": "Caixa com 10 resmas de papel sulfite A4 75g",
            "unit_cost": 229.9,
            "unit": "cx",
            "product_type": "finished_good",
            "barcode": "PAPEL-A4-CX10-083590",
            "is_active": true,
            "dimensions": {
                "height": 3,
                "width": 3.5,
                "length": 4.5,
                "weight": 25
            },
            "dimensions_description": "3.0cm (A) × 3.5cm (L) × 4.5cm (C) | 25.000kg",
            "characteristics": {
                "is_dangerous": false,
                "is_fragile": false,
                "has_serial_number": false,
                "has_batch_control": false,
                "has_ean": false
            },
            "stock_control": {
                "restock_priority": 3,
                "restock_priority_description": "Alta",
                "min_stock_quantity": 5,
                "ideal_stock_quantity": 25
            },
            "expiration_control": {
                "has_expiration_date": false,
                "shelf_life_days": null,
                "min_remaining_shelf_life": null,
                "expiration_alert_days": null
            },
            "temperature_control": {
                "is_refrigerated": false,
                "storage_temp_min": null,
                "storage_temp_max": null
            },
            "created_at": "2025-09-05T14:46:30.000000Z",
            "updated_at": "2025-09-05T14:46:30.000000Z"
        },
        {
            "sku": "CX-PAPEL-001",
            "name": "Caixa de Papelão para Envio",
            "description": "Caixa de papelão para envio de produtos",
            "unit_cost": 3.5,
            "unit": "un",
            "product_type": "finished_good",
            "barcode": "CX-PAPEL-001-083590",
            "is_active": true,
            "dimensions": {
                "height": 3,
                "width": 4,
                "length": 5,
                "weight": 0.5
            },
            "dimensions_description": "3.0cm (A) × 4.0cm (L) × 5.0cm (C) | 0.500kg",
            "characteristics": {
                "is_dangerous": false,
                "is_fragile": false,
                "has_serial_number": false,
                "has_batch_control": false,
                "has_ean": false
            },
            "stock_control": {
                "restock_priority": 3,
                "restock_priority_description": "Alta",
                "min_stock_quantity": 50,
                "ideal_stock_quantity": 200
            },
            "expiration_control": {
                "has_expiration_date": false,
                "shelf_life_days": null,
                "min_remaining_shelf_life": null,
                "expiration_alert_days": null
            },
            "temperature_control": {
                "is_refrigerated": false,
                "storage_temp_min": null,
                "storage_temp_max": null
            },
            "created_at": "2025-09-05T14:46:30.000000Z",
            "updated_at": "2025-09-05T14:46:30.000000Z"
        },
        {
            "sku": "ENV-SEC-ECON",
            "name": "Envelope de Segurança Economic",
            "description": "Envelope de segurança Economic para documentos importantes",
            "unit_cost": 1.2,
            "unit": "un",
            "product_type": "finished_good",
            "barcode": "ENV-SEC-ECON-083590",
            "is_active": true,
            "dimensions": {
                "height": 0.1,
                "width": 2.3,
                "length": 3.2,
                "weight": 0.05
            },
            "dimensions_description": "0.1cm (A) × 2.3cm (L) × 3.2cm (C) | 0.050kg",
            "characteristics": {
                "is_dangerous": false,
                "is_fragile": false,
                "has_serial_number": false,
                "has_batch_control": false,
                "has_ean": false
            },
            "stock_control": {
                "restock_priority": 3,
                "restock_priority_description": "Alta",
                "min_stock_quantity": 100,
                "ideal_stock_quantity": 500
            },
            "expiration_control": {
                "has_expiration_date": false,
                "shelf_life_days": null,
                "min_remaining_shelf_life": null,
                "expiration_alert_days": null
            },
            "temperature_control": {
                "is_refrigerated": false,
                "storage_temp_min": null,
                "storage_temp_max": null
            },
            "created_at": "2025-09-05T14:46:30.000000Z",
            "updated_at": "2025-09-05T14:46:30.000000Z"
        },
        {
            "sku": "ENV-SEC-COEX",
            "name": "Envelope de Segurança COEX",
            "description": "Envelope de segurança COEX com bolha PEBD liso 12x18+3cm",
            "unit_cost": 2.5,
            "unit": "un",
            "product_type": "finished_good",
            "barcode": "ENV-SEC-COEX-083590",
            "is_active": true,
            "dimensions": {
                "height": 0.1,
                "width": 2.1,
                "length": 3.1,
                "weight": 0.08
            },
            "dimensions_description": "0.1cm (A) × 2.1cm (L) × 3.1cm (C) | 0.080kg",
            "characteristics": {
                "is_dangerous": false,
                "is_fragile": false,
                "has_serial_number": false,
                "has_batch_control": false,
                "has_ean": false
            },
            "stock_control": {
                "restock_priority": 3,
                "restock_priority_description": "Alta",
                "min_stock_quantity": 100,
                "ideal_stock_quantity": 500
            },
            "expiration_control": {
                "has_expiration_date": false,
                "shelf_life_days": null,
                "min_remaining_shelf_life": null,
                "expiration_alert_days": null
            },
            "temperature_control": {
                "is_refrigerated": false,
                "storage_temp_min": null,
                "storage_temp_max": null
            },
            "created_at": "2025-09-05T14:46:30.000000Z",
            "updated_at": "2025-09-05T14:46:30.000000Z"
        }
    ]
}
🟠400Filtro inválido
Modified at 2025-09-05 14:55:46
Previous
📦 Conceitos de Produtos
Next
Criar um novo produto
Built with