Fulfillment - Manual da API
  1. Gerenciamento
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
        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 do produto
        GET
      • Adicionar um código fiscal no produto
        POST
      • Detalhes do código fiscal do produto
        GET
      • Modificar código fiscal do produto
        PUT
      • Excluir código fiscal do produto
        DELETE
  • 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
    • 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

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": "kafe",
    "filters": {
        "is_active": "true"
    },
    "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": [
        {
            "sku": "ALIM-CAFE-CX12",
            "name": "Café Gourmet (Cx 12x500g)",
            "description": "Caixa com 12 pacotes de café gourmet torrado e moído",
            "unit_cost": 239.9,
            "unit": "un",
            "barcode": "ALIM-CAFE-CX12-851918",
            "is_active": true,
            "dimensions": {
                "height": 400,
                "width": 300,
                "length": 200,
                "weight": 6
            },
            "dimensions_description": "40.0cm (A) × 30.0cm (L) × 20.0cm (C) | 6g",
            "characteristics": {
                "is_dangerous": false,
                "is_fragile": false,
                "has_serial_number": false,
                "has_batch_control": true,
                "has_ean": false
            },
            "stock_control": {
                "restock_priority": 3,
                "restock_priority_description": "Alta",
                "min_stock_quantity": 5,
                "ideal_stock_quantity": 15
            },
            "expiration_control": {
                "has_expiration_date": true,
                "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-07-18T15:18:38.000000Z",
            "updated_at": "2025-07-18T15:18:38.000000Z"
        }
    ]
}
🟠400Filtro inválido
Previous
📦 Conceitos de Produtos
Next
Criar um novo produto
Built with