Como gerar cupons em massa?

VTEX Team

VTEX Team

Última atualização

A criação de cupons para promoções deve ser feito a partir do módulo Pricing e está documentado em nosso artigo cupons. Porém, podem ocorrer casos em que é necessário criar muitos cupons de uma vez, devido a alguma campanha ou ação de marketing. Nesse caso, é possível criar cupons em massa através de API Rest. Veja abaixo os requisitos para chamar essa API:

  • Header: Content-Type / Value: application/json
  • Header: x-vtex-api-appKey / Value: AppKey da loja, conforme cadastrado no License Manager
  • Header: x-vtex-api-appToken / Value: AppToken da loja, conforme cadastrado no License Manger
  • URL: rnb.vtexcommercestable.com.br/api/rnb/pvt/coupon?an=**nomedaloja**
  • Método: Post
  • Headers:
    • Header: Content-Type / Value: application/json
    • Header: x-vtex-api-appKey / Value: AppKey da loja, conforme cadastrado no License Manager
    • Header: x-vtex-api-appToken / Value: AppToken da loja, conforme cadastrado no License Manger

Body:

{

"utmSource": "utm_source", //utm_source que estiver cadastrada na promoção

"utmCampaign": "utm_campaign", //utm_campaign que estiver cadastrada na promoção

"couponCode": "coupon_code", // código do cupom que deverá ser inserido no carrinho, para ativar a promoção

"isArchived": false, // campo boleano do tipo verdadeiro ou falso. Caso verdadeiro irá arquivar o cupon.

"maxItemsPerClient": 1, // campo do tipo inteiro. Quantidade máxima de produtos que o cliente poderá comprar, usando esse cupom.

"expirationIntervalPerUse": "00:00:00" // valor padrão

}

Observação: o envio do Body é unitário. Para multiplos envios é necessário criar um robô/página web que faça o envio em massa ou, por exemplo, utilizar o Postman Runner, para automatizar o envio.