Criar cupom

POST

Markdown (LLM)

Cria um cupom para um cardápio da empresa.

Escopo:coupons:write

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

Parâmetros do body

merchantIdinteger

Cardápio em que o cupom vale.

1

codestring

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

"PIX15%"

activeboolean

Indica se o cupom está ativo.

true

Parâmetros da resposta

couponIdnumber

ID do cupom a atualizar.

15283

storeIdnumber

ID do restaurante.

38311

merchantIdnumber

Cardápio em que o cupom vale.

1

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

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354{
  "merchantId": 122,
  "active": true,
  "validity": {
    "startsAt": "2026-09-01T00:00:00.000-03:00",
    "endsAt": null,
    "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": null,
    "firstPurchaseOnly": false,
    "showOnMenu": true,
    "pickupOrLocalOnly": false,
    "excludePromotionalProducts": false,
    "requirePhoneSms": false
  },
  "code": "PIX15",
  "benefit": {
    "appliesTo": "discount",
    "type": "percentage",
    "amount": 15
  },
  "advanced": {
    "paymentMethods": [
      {
        "paymentMethodId": 229029,
        "name": "PIX Bee",
        "type": "PIX_BEEFOOD"
      }
    ],
    "application": {
      "mode": "order",
      "sectors": [],
      "products": []
    }
  }
}

Linguagem

Produção

Requisição

POST /v1/store/coupons

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162import axios from "axios";
const { data } = await axios({
  method: "post",
  url: "https://api.beefood.app/v1/store/coupons",
  headers: {
    Authorization: `Bearer ${accessToken}`,
  },
  data: {
    "merchantId": 122,
    "active": true,
    "validity": {
      "startsAt": "2026-09-01T00:00:00.000-03:00",
      "endsAt": null,
      "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": null,
      "firstPurchaseOnly": false,
      "showOnMenu": true,
      "pickupOrLocalOnly": false,
      "excludePromotionalProducts": false,
      "requirePhoneSms": false
    },
    "code": "PIX15",
    "benefit": {
      "appliesTo": "discount",
      "type": "percentage",
      "amount": 15
    },
    "advanced": {
      "paymentMethods": [
        {
          "paymentMethodId": 229029,
          "name": "PIX Bee",
          "type": "PIX_BEEFOOD"
        }
      ],
      "application": {
        "mode": "order",
        "sectors": [],
        "products": []
      }
    }
  },
});

Resposta

json

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950{
  "couponId": 15283,
  "storeId": 38311,
  "merchantId": 1,
  "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": [],
    "application": {
      "mode": "order",
      "sectors": [],
      "products": []
    }
  }
}