Fulfillment - Manual da API
  1. Tipos de Operações
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
      GET
    • Tipo de Operação
      GET
  • 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. Tipos de Operações

♻️ Tipos de Operação

O que são Tipos de Operação no Fulfillment?#

Os Tipos de Operação definem como as mercadorias se movimentam dentro do armazém.
Cada tipo representa um fluxo específico de trabalho (workflow) que determina quais etapas devem ser executadas e quem é responsável por cada uma delas.
Pense nos tipos de operação como "receitas" que definem:
📋 Quais etapas devem ser executadas
👤 Quem executa cada etapa (você ou nossa equipe)
📄 Quais documentos são necessários
🎯 Qual o objetivo final da operação

...

{
    "id": 6,
    "name": "Pedido de Venda - Marketplace",
    "description": "Saída de mercadorias para canais de venda",
    "code": "SAI-ERP",
    "module": "outbound",
    "requires_items": true,
    "requires_order_number": false,
    "workflow_summary": {
        "customer_participation": "Participação mínima necessária",
        "customer_steps_count": 2,
        "total_steps_count": 9,
        "participation_level": "low",
        "participation_percentage": 22
    },
    "requires_fiscal_documents": true
},

...

{
    "id": 7,
    "name": "Perda de Material",
    "description": "Saída de mercadorias por perda ou avaria",
    "code": "SAI-PERDA",
    "module": "outbound",
    "requires_items": true,
    "requires_order_number": false,
    "workflow_summary": {
        "customer_participation": "Operação totalmente gerenciada",
        "customer_steps_count": 0,
        "total_steps_count": 2,
        "participation_level": "none"
    },
    "requires_fiscal_documents": false
},

...

Principais Categorias de Operação#

Entradas (Inbound) 📥#

Operações que adicionam mercadorias ao seu estoque:
Entrada de Mercadoria: Envio de mercadorias ao Fulfillment
Devolução de Cliente: Produtos que retornam ao estoque devido a devolução de clientes

Saídas (Outbound) 📤#

Operações que retiram mercadorias do seu estoque:
Pedido de Venda - Padrão: Qualquer finalidade de venda
Pedido de Venda - Marketplace: Vendas integradas a canais de venda
Perda de Material: Baixa por avaria ou vencimento
Transferência para Outro Depósito: Envio para outro armazém beta

Workflows#

Cada tipo de operação possui um workflow personalizado com etapas divididas entre:

🟢 Etapas do Cliente (você executa)#

Tarefas que ficam sob sua responsabilidade:
Agendamento de horários
Upload de documentos fiscais
Impressão de etiquetas
Confirmação de dados

🔵 Etapas Internas (nossa equipe executa)#

Tarefas operacionais que nossa equipe realiza:
Conferência física dos produtos
Movimentação no estoque
Controle de qualidade

Exemplo de workflows na API#

"customer_workflow": {
    "message": "Você poderá executar as seguintes etapas:",
    "total_customer_steps": 2,
    "customer_steps": [
        {
            "step_number": 1,
            "name": "Agendamento",
            "description": "Reserve um horário na doca para sua operação",
            "icon": "calendar",
            "can_execute": true
        },
        {
            "step_number": 2,
            "name": "Etiquetagem de Produtos",
            "description": "Imprima etiquetas de identificação dos seus produtos",
            "icon": "scan",
            "can_execute": true
        }
    ],
    "internal_steps": {
        "message": "As seguintes etapas serão gerenciadas automaticamente pela nossa equipe:",
        "total_internal_steps": 3,
        "steps": [
            {
                "step_number": 3,
                "name": "Confirmação do Pedido",
                "description": "Confirme que tudo está correto para prosseguir",
                "icon": "thumbs-up",
                "managed_by": "Nossa equipe"
            },
            {
                "step_number": 4,
                "name": "Conferência",
                "description": "Conferência dos itens será realizada",
                "icon": "check-circle",
                "managed_by": "Nossa equipe"
            },
            {
                "step_number": 5,
                "name": "Movimentação de Estoque",
                "description": "Movimentação no estoque será processada",
                "icon": "package",
                "managed_by": "Nossa equipe"
            }
        ]
    }
},
```
Previous
Excluir código fiscal do produto
Next
📦 Entrada de Mercadoria
Built with