Fulfillment - Manual da API
  1. Pedidos - 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
      • 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 de Produtos
      • Códigos fiscais
      • Código fiscal
      • Código fiscal
      • Código fiscal
      • Código fiscal
    • RMA
      • Estatísticas
      • Qualidade
      • Ocorrências
  • 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
        GET
      • Novo Pedido
        POST
      • Detalhes do Pedido
        GET
      • Confirmar Pedido
        POST
      • Update Order
        PUT
    • Workflows
      • Situação atual de um pedido
        GET
      • Fluxos de execução disponíveis
        GET
      • Avançar Workflow
        POST
      • Cancelar Pedido / Workflow
        POST
    • 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
        GET
      • Slots Disponíveis
        GET
      • Reservar Slots
        POST
      • Cancelar Agendamento
        POST
      • Confirmar Agendamento
        POST
    • Identificação de Produtos
      • Etiquetas
        GET
      • Gerar Etiquetas
        POST
      • Confirmar impressão
        POST
    • Documentos Fiscais
      • Documentos Fiscais
        GET
      • Documento Fiscal
        POST
      • Detalhes do Documento
        GET
      • Excluir Documento
        DELETE
    • Documentos para Impressão
      • Documentos
        GET
      • Adicionar Documento
        POST
      • Detalhes do Documento
        GET
      • Pré-visualização
        GET
      • Excluir Documento
        DELETE
  • 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. Pedidos - Gerenciamento

🛒 Pedidos Fulfillment

A API de Pedidos oferece um conjunto completo de endpoints para gerenciar o ciclo de vida de pedidos dentro da plataforma de Fulfillment.
Esta API foi desenvolvida para centralizar todas as operações relacionadas a pedidos oriundos de diferentes canais integrados, como marketplaces (Mercado Livre, Amazon), sistemas de gestão (ERPs), ou fluxos próprios da empresa.

🎯 Objetivos Principais#

Esta API serve como o ponto de entrada unificado para:
Criação de pedidos: Entrada e saída de mercadorias com validação de estoque avançada
Consulta e rastreamento: Acompanhamento completo do status e localização dos itens
Gestão documental: Controle de notas fiscais, etiquetas de identificação e documentos para impressão
Automação logística: Agendamento de coletas/entregas e execução automatizada do workflow

Principais Funcionalidades#

🆕 Criação de Pedidos#

Permite criar novos pedidos de entrada ou saída com validação automática de estoque.
Endpoint: POST /api/v1/orders

🔍 Consulta de Pedidos#

Recupera informações detalhadas de um pedido específico, incluindo status atual, itens, documentos fiscais e histórico de movimentações.
Endpoint: GET /api/v1/orders/{order_number}

📦 Gerenciamento de Itens#

Permite modificar itens do pedido apenas quando o pedido está em status draft. Após o pedido ser confirmado, os itens ficam bloqueados para edição.
Endpoints principais:
GET|POST /api/v1/orders/{order_number}/items
GET|PUT|DELETE /api/v1/orders/{order_number}/items/{item_id}

🧬 Rastreabilidade (Série/Lote)#

Sistema avançado de rastreamento individual por item, essencial para produtos que exigem controle de lote, validade ou número de série.
Endpoints principais:
POST /api/v1/orders/{order_number}/items/{item_id}/traces
GET|PUT|DELETE /api/v1/orders/{order_number}/items/{item_id}/traces/{trace_id}
Aplicações:
Produtos farmacêuticos: Controle de lote e validade obrigatórios
Eletrônicos: Rastreamento por número de série/IMEI
Alimentos: Gestão de prazos de validade e recall
Produtos regulamentados: Compliance com órgãos fiscalizadores

🧾 Documentos Fiscais#

Centralização de toda documentação fiscal relacionada ao pedido, com validação automática e integração com sistemas contábeis.
Endpoints principais:
GET|POST /api/v1/orders/{order_number}/documents
GET|DELETE /api/v1/orders/{order_number}/documents/{document_id}
Tipos de documentos suportados:
Notas fiscais de entrada/saída (XML/PDF)
Conhecimentos de transporte (CT-e) beta
Manifesto de carga (MDF-e) beta
Documentos auxiliares (DANFE, laudos técnicos) beta

🏷️ Etiquetas de Identificação#

Geração automatizada de etiquetas personalizadas para identificação e rastreamento de produtos no armazém.
Formatos suportados: ZPL (Zebra)
Endpoints principais:
POST /api/v1/orders/{order_number}/product-identification/items/{item_id}/labels/render
POST /api/v1/orders/{order_number}/product-identification/items/{item_id}/labels/mark-as-printed
Tipos de etiquetas:
Etiquetas de produto: Código QR e informações básicas
Etiquetas de controle: Lote, validade e série

🖨️ Documentos para Impressão#

Sistema centralizado para anexar e gerenciar documentos diversos que precisam ser impressos junto com o pedido.
Documentos suportados:
Laudos técnicos: Certificados de qualidade, análises laboratoriais
Etiquetas customizadas: PDF ou ZPL para impressão especializada
Orçamentos e propostas: Documentos comerciais
Instruções especiais: Manuais de manuseio, cuidados especiais
Certificações: ISO, ANVISA, outros órgãos reguladores
Endpoints principais:
POST /api/v1/orders/{order_number}/print-documents
GET /api/v1/orders/{order_number}/print-documents
GET /api/v1/orders/{order_number}/print-documents/{documentId}
GET /api/v1/orders/{order_number}/print-documents/{documentId}/preview

📅 Agendamento Fulfillment#

Controle completo de agendamentos para coletas e entregas, otimizando o uso da capacidade logística do armazém.
Fluxo de agendamento:
1.
Consulta de disponibilidade: Verificar slots livres por dock/período
2.
Reserva temporária: Bloquear horário por tempo limitado
3.
Confirmação: Efetivar o agendamento
Endpoints principais:
GET /api/v1/orders/{order_number}/schedules/available
POST /api/v1/orders/{order_number}/schedules/reserve
POST /api/v1/orders/{order_number}/schedules/confirm
GET /api/v1/orders/{order_number}/schedules
POST /api/v1/orders/{order_number}/schedules/cancel

🔄 Controle de Workflow#

Através deste módulo, o usuário pode visualizar em que etapa o pedido se encontra e confirmar as ações pelas quais é responsável, como envio de notas fiscais, confirmação de itens ou outras aprovações necessárias no fluxo.
Endpoints principais:
GET /api/v1/orders/{order_number}/workflow/status
GET /api/v1/orders/{order_number}/workflow/available-actions
POST /api/v1/orders/{order_number}/workflow/execute
POST /api/v1/orders/{order_number}/workflow/cancel
Modified at 2025-09-01 14:44:47
Previous
Modificar Endereço
Next
Pedidos
Built with