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
      • 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
    • 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
        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
  • 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

Novo Pedido

Developing
POST
/api/v1/orders

Request

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

Examples
{
    "operation_type_id": 6,
    "warehouse_id": 1,
    "status": "confirmed",
    "notes": "Descrição do Pedido",
    "recipient_id": "01k0fd8ebhxep94x6hbkjqhpsc",
    "recipient_address_id": "01k0fp6p7jnkcyv37fcnxp9vd3",
    "channel_id": 1,
    "items": [
        {
            "sku": "ESBOLHA12x18-100",
            "quantity": 1
        }
    ]
}

Responses

🟢201Created
application/json
Body

Example
{
    "success": true,
    "message": "Order criada com sucesso",
    "data": {
        "order_number": "OUTMKT202507.000008",
        "order_type": "out",
        "status": "in_progress",
        "substatus": {
            "value": "awaiting_fiscal_validation",
            "label": "Aguardando Validação Fiscal",
            "description": "Pedido aguardando validação fiscal"
        },
        "is_confirmed": true,
        "is_packed": false,
        "warehouse": {
            "warehouse_id": 1,
            "name": "001 - Pari - SP"
        },
        "items": [
            {
                "item_id": 14,
                "product": {
                    "sku": "ESBOLHA12x18-100",
                    "name": "Envelope de Segurança com Bolha 12x18cm",
                    "has_ean": false,
                    "barcode": "ESBOLHA12x18-100-207476",
                    "description": "Envelope de segurança COEX com bolha PEBD liso 12x18+3cm",
                    "has_serial_number": false,
                    "has_batch_control": false,
                    "has_expiration_date": false
                },
                "quantity": 1,
                "quantity_processed": 0,
                "status": "pending",
                "batch_number": null,
                "serial_number": null,
                "additional_data": []
            }
        ],
        "customer_owner": {
            "customer_id": "01k0smxx1kpqf78qd0fg1wyypc",
            "name": "Loja Diversificada Mix",
            "document": "51115210000166"
        },
        "operation_type": {
            "operation_type_id": 6,
            "name": "Pedido de Venda - Marketplace",
            "description": "Saída de mercadorias para venda com emissão de NF",
            "module": "outbound",
            "can_be_created_by_customer": true
        },
        "channel": {
            "channel_id": 1,
            "name": "Pedido ERP",
            "channel": "generic",
            "channel_label": "Genérico",
            "is_active": true,
            "settings": {
                "channel_name": "Pedido ERP"
            }
        },
        "recipient_id": "01k0smxznjb02b9z2skk5g03sf",
        "recipient": {
            "id": "01k0smxznjb02b9z2skk5g03sf",
            "name": "Consumidor Final 010",
            "email": "customer-010@demo.com",
            "document": "12345678910",
            "ie": null,
            "phone": "(11) 99999-9999"
        },
        "recipient_address_id": "01k0smyswh8818f0b57970zvnc",
        "recipient_address": {
            "id": "01k0smyswh8818f0b57970zvnc",
            "street": "Rua Augusta",
            "number": "456",
            "complement": null,
            "neighborhood": "Consolação",
            "city": "São Paulo",
            "state": "SP",
            "postal_code": null
        },
        "carrier_id": "01k0smxxjkframwp0wwbmwhaf3",
        "carrier": {
            "carrier_id": "01k0smxxjkframwp0wwbmwhaf3",
            "name": "Jamef - Matriz",
            "document": "45.678.901/0001-34",
            "ie": null,
            "code": null,
            "is_active": true
        },
        "notes": "Descrição do Pedido",
        "created_by_id": 1005,
        "created_by_type": "Customer",
        "created_at": "2025-07-22T18:14:53.000000Z",
        "created_at_formatted": "22/07/2025 15:14",
        "updated_at": "2025-07-22T18:14:53.000000Z",
        "updated_at_formatted": "22/07/2025 15:14"
    }
}
🟠422Erro de parâmetro
Previous
Pedidos
Next
Detalhes do Pedido
Built with