POST /orders

Cria um novo pedido no sistema.

Campos do Body

origin (string, obrigatório) — Origem do pedido (WhatsApp, Totem).

deliveryType (string, obrigatório) — Tipo de entrega (Delivery, Balcão).

customer (object, obrigatório se Delivery) — Cliente associado ao pedido.

address (object, obrigatório se Delivery) — Endereço de entrega.

payments (array, obrigatório) — Métodos de pagamento e valores.

items (array, obrigatório) — Lista de itens do pedido.

total (object, obrigatório) — Totais e descontos.

externalCode (string, opcional) — Identificador do pedido no seu sistema, com até 64 caracteres. Único por filial, inclusive para pedidos cancelados. Envie sempre como string.

pickupCode (string, opcional) — Senha do pedido, com até 10 caracteres. Em pedido Balcão de filial com senha sequencial ativa, o valor enviado é ignorado e a senha é gerada pelo sistema.

Na seção de customer:
Se o customer tiver cadastro, envie apenas customer.id
Caso contrário, envie os dados do cliente que será cadastrado no momento da inserção do pedido.

Pagamento com TEF

Envie tef dentro do pagamento:

tef.cnpj (string, obrigatório) — CNPJ da credenciadora, com 14 dígitos ou no formato 00.000.000/0000-00.

tef.authorizationNumber (string, obrigatório) — Código de autorização, com até 30 caracteres.

tef.nsu (string, opcional) — NSU, com até 30 caracteres.

Para a NFC-e sair com os dados do cartão, use method igual a Cartão de Crédito ou Cartão de Débito, com card.brand e tef. Com method igual a TEF, a nota é emitida como "Outros" (99), sem os dados do cartão.

Exemplo de Requisição

{
  "origin": "WhatsApp",
  "deliveryType": "Delivery",
  "externalCode": "PAG-123",
  "pickupCode": "131",
  "documentReceipt": "123.456.789-00",
  "observations": "Entregar na portaria",
  "customer": {
    "name": "John Doe",
    "email": "johndoe@alfamail.com",
    "phone": "47988419082",
    "document": "12345678912"
  },
  "address": {
    "streetName": "Rua das Flores",
    "streetNumber": "123",
    "postalCode": "12345678",
    "city": "Florianópolis",
    "neighborhood": "Centro",
    "state": "SC",
    "country": "Brasil",
    "reference": "Próximo ao mercado",
    "complement": "Apto 101",
    "coordinates": {
      "latitude": -27.5954,
      "longitude": -48.5480
    }
  },
  "payments": [
    {
      "method": "Cartão de Crédito",
      "value": 20.00,
      "card": {
        "brand": "Visa"
      },
      "tef": {
        "cnpj": "12345678000190",
        "authorizationNumber": "A12345",
        "nsu": "000123"
      }
    },
    {
      "method": "Dinheiro",
      "value": 24.00,
      "cash": {
        "changeFor": 30.00
      }
    }
  ],
  "items": [
    {
      "name": "X-Burguer Completo",
      "externalCode": "XB001",
      "quantity": 1,
      "unitPrice": 25.50,
      "price": 25.50,
      "category": "Lanches",
      "observations": "Sem cebola",
      "flavors": ["Bovino"],
      "additions": ["Bacon", "Queijo Extra"],
      "complements": [
        {
          "title": "Escolha o Pão",
          "isFraction": false,
          "chargeHigherPrice": false,
          "chargeMediumPrice": false,
          "options": [
            {
              "name": "Pão Australiano",
              "externalCode": "PAO001",
              "quantity": 1,
              "unitPrice": 2.00,
              "price": 2.00
            }
          ]
        },
        {
          "title": "Adicionais",
          "isFraction": false,
          "chargeHigherPrice": true,
          "chargeMediumPrice": false,
          "options": [
            {
              "name": "Ovo",
              "externalCode": "OVO001",
              "quantity": 1,
              "unitPrice": 1.50,
              "price": 1.50
            },
            {
              "name": "Batata Palha",
              "externalCode": "BAT001",
              "quantity": 1,
              "unitPrice": 1.00,
              "price": 1.00
            }
          ]
        },
        {
          "title": "Bebida",
          "isFraction": false,
          "chargeHigherPrice": false,
          "chargeMediumPrice": true,
          "options": [
            {
              "name": "Coca-Cola 350ml",
              "externalCode": "COC001",
              "quantity": 1,
              "unitPrice": 4.50,
              "price": 4.50
            }
          ]
        }
      ]
    },
    {
      "name": "Batata Frita",
      "externalCode": "BAT002",
      "quantity": 2,
      "unitPrice": 8.00,
      "price": 16.00,
      "category": "Acompanhamentos",
      "observations": null,
      "flavors": [],
      "additions": ["Cheddar", "Bacon"],
      "complements": []
    }
  ],
  "total": {
    "subTotal": 41.50,
    "deliveryFee": 5.00,
    "discount": 5.00,
    "addition": 2.50,
    "orderAmount": 44.00
  }
}

Exemplo de Resposta (200)

{
  "id": 564,
  "num": 3968,
  "pickupCode": "131",
  "data": {
    "id": 564,
    "num": 3968,
    "data": "2026-11-04 15:03:13",
    "pickupCode": "131"
  }
}

Pedido já existente (409)

{
  "success": false,
  "message": "Order already exists",
  "id": 564
}

Antes de reenviar após uma falha de rede, consulte GET /orders?externalCode=.... O 409 traz o id do pedido já criado, e não há novo pedido nesse caso.

Códigos de Resposta

Código	Descrição
200	Pedido criado com sucesso
400	Dados inválidos
401	Token ausente ou inválido
409	Código externo já usado
500	Erro interno
502	Resposta inválida ao processar o pedido
504	Tempo esgotado; consulte pelo `externalCode` antes de reenviar

Campos do Body#

Pagamento com TEF#

Exemplo de Requisição#

Exemplo de Resposta (200)#

Pedido já existente (409)#

Códigos de Resposta#