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

Tipo de Operação

Developing
GET
/api/v1/operation-types/{operation_type_id}
Retorna os detalhes completos de um Tipo de Operação específico.

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

Examples
{
    "success": true,
    "message": "Tipo de operação recuperado com sucesso",
    "data": {
        "id": 4,
        "name": "Entrada de Mercadoria - Fulfillment",
        "description": "Entrada de mercadorias com agendamento & validação de documento fiscal",
        "code": "ENT-FUL",
        "module": "inbound",
        "requires_items": false,
        "allows_items_after_start": true,
        "requires_order_number": false,
        "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"
                    }
                ]
            }
        },
        "fiscal_requirements": {
            "required": true,
            "message": "Documentos fiscais obrigatórios:",
            "documents": [
                {
                    "document_type": "Nota Fiscal (XML)",
                    "description": "Documento obrigatório com CFOP válido",
                    "validation_rules": {
                        "cfop": {
                            "required": true,
                            "valid_codes": [
                                "1102",
                                "1403",
                                "1556",
                                "2102",
                                "2403",
                                "2556"
                            ],
                            "description": "Código Fiscal de Operações e Prestações deve ser um dos valores permitidos"
                        }
                    },
                    "help_text": "Requisitos específicos: CFOPs aceitos: 1102, 1403, 1556, 2102, 2403, 2556"
                }
            ],
            "general_tips": [
                "Certifique-se de que os XMLs estão válidos e sem erros",
                "Mantenha os documentos organizados por data",
                "Verifique se todas as informações fiscais estão corretas"
            ]
        }
    }
}
🟠404Registro não encontrado
Previous
Tipos de Operações
Next
👔 Clientes & Parceiros
Built with