1. Discount Coupons
Alfalabs API v2
  • Raiz
    • Orders
      • GET /orders
      • POST /orders
      • PUT /orders/status
    • Users
      • GET /users
    • Delivery
      • GET /deliveryAreas
    • Nfc
      • GET /nfc
      • POST /nfc
    • Ratings
      • GET /ratings
    • Accounts
      • GET /accounts
    • Discount Coupons
      • GET /discountCoupons
        GET
      • GET /discountCoupons/id
        GET
      • POST /discountCoupons
        POST
      • PUT /discountCoupons
        PUT
      • DELETE /discountCoupons
        DELETE
    • Webhook
  1. Discount Coupons

PUT /discountCoupons

PUT
/v2/discountCoupons/{id}

Atualiza um cupom de desconto#

PUT /v2/discountCoupons/:id

Path Parameters#

ParâmetroTipoObrigatórioDescrição
idintegerObrigatórioID do cupom de desconto

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âmetroTipoObrigatórioDescrição
codestringObrigatórioCódigo do cupom
descriptionstringObrigatórioDescrição do cupom
discount_typestringObrigatórioTipo de desconto (R$ ou %)
discount_valuenumberObrigatórioValor do desconto
filial_idintegerObrigatórioID da filial
valid_abovenumberOpcionalVálido para pedidos acima deste valor
first_order_onlybooleanOpcionalApenas no primeiro pedido do usuário
uses_per_customerintegerOpcionalLimite de usos por cliente
start_datestringOpcionalData de início (YYYY-MM-DD)
end_datestringOpcionalData de fim (YYYY-MM-DD)
delivery_discountbooleanOpcionalAplicar desconto na taxa de entrega
free_deliverybooleanOpcionalEntrega grátis (desconto 100% na entrega)
block_promotionbooleanOpcionalNão aplicar nas promoções
visiblebooleanOpcionalCupom visível
auto_applybooleanOpcionalAplicar automaticamente
restrictionsobjectOpcionalRestrições do cupom
restrictions.delivery_typestringOpcionalTipo de entrega permitido
restrictions.week_daysarrayOpcionalArray de 7 booleanos (dias da semana)
restrictions.menuarrayOpcionalArray de itens do cardápio
restrictions.menu[].idstringObrigatórioID do item
restrictions.menu[].namestringObrigatórioNome do item
restrictions.menu[].typestringObrigatórioTipo do item (categoria, promoção, pizza, produto)
restrictions.neighborhoodsarrayOpcionalArray de bairros
restrictions.neighborhoods[].idintegerObrigatórioID do bairro
restrictions.neighborhoods[].namestringObrigatórioNome do bairro
restrictions.customersarrayOpcionalArray de clientes
restrictions.customers[].idintegerObrigatórioID do cliente
restrictions.customers[].namestringObrigatórioNome do cliente

Exemplo de Request Body#

{
  "code": "TESTE_API_V2_UPDATED",
  "description": "Cupom atualizado via API v2",
  "discount_type": "%",
  "discount_value": 15.0,
  "valid_above": 20.00,
  "first_order_only": false,
  "uses_per_customer": 5,
  "start_date": "2024-02-01",
  "end_date": "2024-11-30",
  "delivery_discount": true,
  "free_delivery": false,
  "filial_id": 1,
  "block_promotion": false,
  "visible": true,
  "auto_apply": false,
  "restrictions": {
    "delivery_type": "todos",
    "week_days": [
      true,
      true,
      true,
      true,
      true,
      false,
      false
    ],
    "menu": [
      {
        "id": "50",
        "name": "Categoria Pizzas",
        "type": "categoria"
      }
    ],
    "neighborhoods": [
      {
        "id": 1,
        "name": "Bombas"
      }
    ],
    "customers": null
  }
}###ExemplodeResposta(200){
  "id": 2110,
  "code": "TESTE_API_V2_UPDATED",
  "active": false,
  "description": "Cupom atualizado via API v2",
  "discount_type": "%",
  "discount_value": 15.0,
  "valid_above": 20.00,
  "first_order_only": false,
  "uses_per_customer": 5,
  "start_date": "2024-02-01",
  "end_date": "2024-11-30",
  "delivery_discount": true,
  "free_delivery": false,
  "filial_id": 1,
  "block_promotion": false,
  "visible": true,
  "auto_apply": false,
  "restrictions": {
    "delivery_type": "todos",
    "week_days": [
      true,
      true,
      true,
      true,
      true,
      false,
      false
    ],
    "menu": [
      {
        "id": "50",
        "name": "Categoria Pizzas",
        "type": "categoria"
      }
    ],
    "neighborhoods": [
      {
        "id": 1,
        "name": "Bombas"
      }
    ],
    "customers": null
  }
}

Requisição

Authorization
Forneça seu token bearer no cabeçalho
Authorization
ao fazer requisições para recursos protegidos.
Exemplo:
Authorization: Bearer ********************
Parâmetros de Caminho

Parâmetros Header

Respostas

🟢200
application/json
Body

Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request PUT 'https://api.alfalabs.com.br/v2/v2/discountCoupons/' \
--header 'Authorization: Bearer <token>'
Response Response Example
{}
Modificado em 2026-04-27 19:39:30
Página anterior
POST /discountCoupons
Próxima página
DELETE /discountCoupons
Built with