Atualizar cupom

PATCH

Markdown (LLM)

Atualiza parcialmente um cupom da empresa.

Escopo:coupons:write

Limite:100 requisições a cada 3 minutos.

Observação

Os campos não enviados terão seu valor preservado; apenas os campos enviados (ou enviados como null) serão alterados.

Parâmetros de path

couponIdinteger

ID do cupom a atualizar.

15283

Parâmetros do body

activeboolean

Indica se o cupom está ativo.

true

codestring

Código para a utilização do cupom.

"ABC123"

channelsobject

Canais em que o cupom vale.

Parâmetros da resposta

couponIdnumber

ID do cupom a atualizar.

15237

storeIdnumber

ID do restaurante.

38311

merchantIdnumber

Cardápio em que o cupom vale.

39202

codestring

Código para a utilização do cupom.

"PIX15%"

activeboolean

Indica se o cupom está ativo.

true

usageCountnumber

Quantas vezes já foi usado.

0

Body (JSON)

json

123{
  "active": false
}

Linguagem

Produção

Requisição

PATCH /v1/store/coupons/{couponId}

1234567891011import axios from "axios";
const { data } = await axios({
  method: "patch",
  url: "https://api.beefood.app/v1/store/coupons/{couponId}",
  headers: {
    Authorization: `Bearer ${accessToken}`,
  },
  data: {
    "active": false
  },
});

Resposta

json

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061{
  "couponId": 15237,
  "storeId": 38311,
  "merchantId": 39202,
  "code": "PIX15%",
  "active": true,
  "usageCount": 0,
  "benefit": {
    "appliesTo": "discount",
    "type": "percentage",
    "amount": 15
  },
  "validity": {
    "startsAt": "2026-08-22T23:34:00.000-03:00",
    "weekdays": {
      "monday": true,
      "tuesday": true,
      "wednesday": true,
      "thursday": true,
      "friday": true,
      "saturday": true,
      "sunday": true
    }
  },
  "channels": {
    "delivery": true,
    "pdv": true,
    "tables": true,
    "totem": true
  },
  "rules": {
    "minimumOrderAmount": 0,
    "limitOnePerCustomer": false,
    "hasQuantityLimit": false,
    "maxQuantity": 0,
    "firstPurchaseOnly": false,
    "showOnMenu": true,
    "pickupOrLocalOnly": false,
    "excludePromotionalProducts": false,
    "requirePhoneSms": true
  },
  "advanced": {
    "paymentMethods": [
      {
        "paymentMethodId": 486229,
        "name": "PIX Bee",
        "type": "PIX_BEEFOOD"
      },
      {
        "paymentMethodId": 381233,
        "name": "PIX Online",
        "type": "PIX_BEEFOOD"
      }
    ],
    "application": {
      "mode": "order",
      "sectors": [],
      "products": []
    }
  }
}