POST /discountCoupons

Cria um novo cupom de desconto

POST /v2/discountCoupons

Body Parameters

Parâmetro de discount_type:
R$ = desconto fixo em reais
% = desconto percentual

Parâmetro de delivery_type (dentro de restrictions):
delivery = apenas delivery
balcao = apenas balcão
todos = todos os tipos de entrega

Parâmetro de type (dentro de restrictions.menu):
categoria = categoria do cardápio
promoção = promoção
pizza = pizza
produto = produto individual

Parâmetro de week_days:
Array de 7 valores booleanos representando os dias da semana (Domingo a Sábado)

Parâmetro	Tipo	Obrigatório	Descrição
code	string	Obrigatório	Código do cupom
description	string	Obrigatório	Descrição do cupom
discount_type	string	Obrigatório	Tipo de desconto (R$ ou %)
discount_value	number	Obrigatório	Valor do desconto
filial_id	integer	Obrigatório	ID da filial
valid_above	number	Opcional	Válido para pedidos acima deste valor
first_order_only	boolean	Opcional	Apenas no primeiro pedido do usuário
uses_per_customer	integer	Opcional	Limite de usos por cliente
start_date	string	Opcional	Data de início (YYYY-MM-DD)
end_date	string	Opcional	Data de fim (YYYY-MM-DD)
delivery_discount	boolean	Opcional	Aplicar desconto na taxa de entrega
free_delivery	boolean	Opcional	Entrega grátis (desconto 100% na entrega)
block_promotion	boolean	Opcional	Não aplicar nas promoções
visible	boolean	Opcional	Cupom visível
auto_apply	boolean	Opcional	Aplicar automaticamente
restrictions	object	Opcional	Restrições do cupom
restrictions.delivery_type	string	Opcional	Tipo de entrega permitido
restrictions.week_days	array	Opcional	Array de 7 booleanos (dias da semana)
restrictions.menu	array	Opcional	Array de itens do cardápio
restrictions.menu[].id	string	Obrigatório	ID do item
restrictions.menu[].name	string	Obrigatório	Nome do item
restrictions.menu[].type	string	Obrigatório	Tipo do item (categoria, promoção, pizza, produto)
restrictions.neighborhoods	array	Opcional	Array de bairros
restrictions.neighborhoods[].id	integer	Obrigatório	ID do bairro
restrictions.neighborhoods[].name	string	Obrigatório	Nome do bairro
restrictions.customers	array	Opcional	Array de clientes
restrictions.customers[].id	integer	Obrigatório	ID do cliente
restrictions.customers[].name	string	Obrigatório	Nome do cliente

Exemplo de Request Body

{
  "code": "TESTE_API_V2",
  "description": "Cupom de teste via API v2",
  "discount_type": "R$",
  "discount_value": 9.99,
  "valid_above": 11.54,
  "first_order_only": true,
  "uses_per_customer": 10,
  "start_date": "2024-01-01",
  "end_date": "2024-12-31",
  "delivery_discount": false,
  "free_delivery": false,
  "filial_id": 1,
  "block_promotion": true,
  "visible": true,
  "auto_apply": true,
  "restrictions": {
    "delivery_type": "delivery",
    "week_days": [
      false,
      true,
      true,
      true,
      true,
      true,
      false
    ],
    "menu": [
      {
        "id": "38",
        "name": "Categoria Bebidas",
        "type": "categoria"
      },
      {
        "id": "107",
        "name": "Monte seu Lanche",
        "type": "promoção"
      }
    ],
    "neighborhoods": [
      {
        "id": 1,
        "name": "Bombas"
      }
    ],
    "customers": [
      {
        "id": 1,
        "name": "Bruno Delfim"
      }
    ]
  }
}

Exemplo de Resposta (200/201)

{
  "id": 2110,
  "code": "TESTE_API_V2",
  "active": false,
  "description": "Cupom de teste via API v2",
  "discount_type": "R$",
  "discount_value": 9.99,
  "valid_above": 11.54,
  "first_order_only": true,
  "uses_per_customer": 10,
  "start_date": "2024-01-01",
  "end_date": "2024-12-31",
  "delivery_discount": false,
  "free_delivery": false,
  "filial_id": 1,
  "block_promotion": true,
  "visible": true,
  "auto_apply": true,
  "restrictions": {
    "delivery_type": "delivery",
    "week_days": [
      false,
      true,
      true,
      true,
      true,
      true,
      false
    ],
    "menu": [
      {
        "id": "38",
        "name": "Categoria Bebidas",
        "type": "categoria"
      }
    ],
    "neighborhoods": [
      {
        "id": 1,
        "name": "Bombas"
      }
    ],
    "customers": [
      {
        "id": 1,
        "name": "Bruno Delfim"
      }
    ]
  }
}

Forneça seu token bearer no cabeçalho

Authorization

ao fazer requisições para recursos protegidos.

Exemplo:

Authorization: Bearer ********************

Body Parameters

Exemplo de Request Body

Exemplo de Resposta (200/201)

Requisição

Respostas

POST /discountCoupons

Body Parameters#

Exemplo de Request Body#

Exemplo de Resposta (200/201)#

Requisição

Respostas

Body Parameters

Exemplo de Request Body

Exemplo de Resposta (200/201)