Fulfillment - Manual da API
  1. Enumeração
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
      • 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
        GET
      • Tipos disponíveis
        GET
    • 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. Enumeração

Enumeração

Developing
GET
/api/v1/enums/{enum-code}
Last modified:2025-09-19 14:22:21
Tipos de Endereço – /address-type
Tipos de Edifício – /building-type
CFOP – /cfop
Canais de Venda – /channel
Tipos de Configuração – /configuration-type
CST COFINS – /cst-cofins
CST ICMS – /cst-icms
CST IPI – /cst-ipi
CST PIS – /cst-pis
Tipos de Documento do Cliente – /customer-document-type
Tipos de Cliente – /customer-type
Tipos de Doca – /dock-type
Tipos de Conteúdo de Documento – /document-content-type
Status de Documento – /document-status
EnumStatus – /enum-status
Tipos de Uso Fiscal – /fiscal-usage-type
Tipos de Etiqueta de Localização – /location-label-type
Status de Localização – /location-status
Tipos de Localização – /location-type
Modos de Operação – /operation-mode
Módulos de Operação – /operation-module
Ações de Pedido – /order-actions
Status de Conferência de Pedido – /order-conference-status
Tipos de Conferência de Pedido – /order-conference-type
Códigos de Erro de Pedido – /order-error-codes
Status de Item de Pedido – /order-item-status
Status de Rastreamento de Item – /order-item-tracer-status
Tipos de Etiqueta de Pedido – /order-label-type
Tipos de Embalagem de Pedido – /order-package-type
Status da Embalagem – /order-packed-item-status
Tipos de Documento de Impressão de Pedido – /order-print-document-type
Status de Pedido – /order-status
Substatus de Pedido – /order-substatus
Tipos de Pedido – /order-type
Documentos do Tipo de Pedido – /order-type-documents
Validações Extras do Tipo de Pedido – /order-type-extra-validations
Tipos de Impressora – /printer-type
Tipos de Etiqueta de Controle de Produto – /product-label-propose
Modelos de Etiquetas de Produto – /product-label-type
Origem do Produto – /product-origin
Tipos de Embalagem de Produto – /product-package-type
Tipos de Produto – /product-type
Unidades de Produto – /product-unit
Resultado de Critérios de Qualidade – /quality-criteria-result
Status de Verificação de Qualidade RMA – /rma-quality-check-status
Critérios de Qualidade RMA – /rma-quality-criteria
Status de Agendamento – /schedule-status
Lados da Rua – /street-side
Tipos de Rua – /street-type
Regimes Tributários – /tax-regime
Funções de Armazém – /warehouse-role
Tipos de Eventos de Webhook – /webhook-event-type
Setores de Workflow – /workflow-sector
Status de Workflow – /workflow-status
Tipos de Workflow – /workflow-type
Tipos de Zona – /zone-type

Request

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

Responses

🟢200TaxRegime
application/json
Body

Example
{
    "success": true,
    "message": "Opções de TaxRegime recuperadas com sucesso",
    "data": [
        {
            "value": "simples_nacional",
            "label": "Simples Nacional",
            "description": "Regime simplificado de tributação para micro e pequenas empresas"
        },
        {
            "value": "lucro_presumido",
            "label": "Lucro Presumido",
            "description": "Regime de tributação baseado em uma margem de lucro presumida"
        },
        {
            "value": "lucro_real",
            "label": "Lucro Real",
            "description": "Regime de tributação baseado no lucro efetivo da empresa"
        },
        {
            "value": "pessoa_fisica",
            "label": "Pessoa Física",
            "description": "Registro de pessoa física, sem impacto fiscal direto"
        },
        {
            "value": "mei",
            "label": "MEI (Microempreendedor Individual)",
            "description": "Microempreendedor Individual, com regime simplificado"
        }
    ]
}
🟢200ScheduleStatus
🟢200DocumentContentType
🟢200CustomerType
🟢200OperationModule
Modified at 2025-09-19 14:22:21
Previous
Eventos Disponíveis
Next
Tipos disponíveis
Built with