> ## Documentation Index > Fetch the complete documentation index at: https://docs.yampi.com.br/llms.txt > Use this file to discover all available pages before exploring further. # Criar cupom > Cria um novo cupom de desconto export const limit_0 = 60 Esta API possui limites de requisições (rate limits) para garantir estabilidade. Cada endpoint tem um limite específico de chamadas por minuto. **Este endpoint em específico tem um limite de {limit_0} requisições por minuto.** ## OpenAPI ````yaml post /{alias}/pricing/promocodes openapi: 3.0.0 info: title: Yampi API description: Documentação oficial da API da Yampi version: '2.0' servers: - url: https://api.dooki.com.br/v2 description: Endpoint de produção security: - ApiToken: [] ApiSecretKey: [] tags: - name: Catálogo - Atualização em massa x-folder: catalogo/atualizacao-em-massa - name: Catálogo - Avaliações de produtos x-folder: catalogo/produtos/avaliacoes-de-produtos - name: Catálogo - Categorias x-folder: catalogo/categorias - name: Catálogo - Coleções x-folder: catalogo/colecoes - name: Catálogo - Comentários de produtos x-folder: catalogo/produtos/comentarios-de-produtos - name: Catálogo - Customizações x-folder: catalogo/customizacoes - name: Catálogo - Estoques de SKU x-folder: catalogo/skus/estoques-de-sku - name: Catálogo - Feeds x-folder: catalogo/feeds - name: Catálogo - Filtros x-folder: catalogo/filtros - name: Catálogo - Grupos x-folder: catalogo/grupos - name: Catálogo - Imagens x-folder: catalogo/imagens - name: Catálogo - Looks x-folder: catalogo/looks - name: Catálogo - Kits x-folder: catalogo/kits - name: Catálogo - Marcas x-folder: catalogo/marcas - name: Catálogo - Notificações de estoque x-folder: catalogo/notificacoes-de-estoque - name: Catálogo - Produtos x-folder: catalogo/produtos - name: Catálogo - Produtos relacionados x-folder: catalogo/produtos/produtos-relacionados - name: Catálogo - Selos x-folder: catalogo/selos - name: Catálogo - Sincronizar estoques x-folder: catalogo/skus/sincronizar-estoques - name: Catálogo - SKUs x-folder: catalogo/skus - name: Catálogo - Valores de filtros x-folder: catalogo/filtros/valores-de-filtros - name: Catálogo - Valores de variações x-folder: catalogo/variacoes/valores-de-variacoes - name: Catálogo - Variações x-folder: catalogo/variacoes - name: Público - Catálogo x-folder: /publico/catalogo - name: Público - Busca x-folder: /publico/busca - name: Público - Loja x-folder: /publico/loja - name: Checkout - Bancos x-folder: checkout/bancos - name: Checkout - Links de Pagamento x-folder: checkout/links-de-pagamento - name: Checkout - Carrinhos abandonados x-folder: checkout/carrinhos-abandonados - name: Checkout - Configurações de pagamentos x-folder: checkout/configuracoes-de-pagamentos - name: Checkout - Formas de pagamentos x-folder: checkout/formas-de-pagamentos - name: Checkout - Gateways de pagamento x-folder: checkout/gateways-de-pagamento - name: Checkout - Parcelamento x-folder: checkout/parcelamento - name: Checkout - Status de pedidos x-folder: checkout/status-de-pedidos - name: Checkout - Transações x-folder: checkout/transacoes - name: Clientes - Cliente x-folder: clientes/cliente - name: Clientes - Clusters description: >- Clusters são grupos de clientes com condições comerciais flexíveis, como preço de produto, frete e forma de entrega x-folder: clientes/clusters - name: Clientes - Endereços x-folder: clientes/enderecos - name: Clientes - Regras de frete dos clusters x-folder: clientes/clusters/regras-de-frete-dos-clusters - name: Configurações - Carrinhos abandonados x-folder: configuracoes/carrinhos-abandonados - name: Configurações - Checkout x-folder: configuracoes/checkout - name: Configurações - Credenciais da loja x-folder: configuracoes/credenciais-da-loja - name: Configurações - Dados da loja x-folder: configuracoes/dados-da-loja - name: Configurações - Fotos x-folder: configuracoes/fotos - name: Configurações - Integrações x-folder: configuracoes/integracoes - name: Configurações - IPs bloqueados x-folder: configuracoes/ips-bloqueados - name: Configurações - Overview x-folder: configuracoes/overview - name: Conteúdo - Páginas x-folder: conteudo/paginas - name: Conteúdo - Redirecionamentos x-folder: conteudo/redirecionamentos - name: Descontos x-folder: descontos - name: Leads x-folder: leads - name: Logística - Armazéns x-folder: logistica/armazens - name: Logística - Simular frete x-folder: logistica/simular-frete - name: Logística - CEP x-folder: logistica/cep - name: Logística - Embalagens x-folder: logistica/embalagens - name: Logística - Estoques description: >- O lojista pode ter um cadastro de múltiplos estoques onde ele pode associar posteriormente os SKUS com suas respectivas quantidades. Um exemplo prático é permitir que ele consiga trabalhar com estoques de fornecedores externos com diferentes prazos de entrega. x-folder: logistica/estoques - name: Logística - Países x-folder: logistica/paises - name: Logística - Preços de frete x-folder: logistica/precos-de-frete - name: Logística - Reservas de estoque x-folder: logistica/reservas-de-estoque - name: Logística - Transportadoras x-folder: logistica/transportadoras - name: Logística - API de Frete x-folder: logistica/api-de-frete - name: Marketing x-folder: marketing - name: Marketing - Brindes x-folder: marketing/brindes - name: Pedidos - Comentários description: Endpoints de comentários de pedidos x-folder: pedidos/comentarios - name: Pedidos - Emails description: Endpoints de e-mails de pedidos x-folder: pedidos/emails - name: Pedidos - Endereços description: Endpoints de endereços de pedidos x-folder: pedidos/enderecos - name: Pedidos - Etiquetas description: Endpoints de etiquetas de pedidos x-folder: pedidos/etiquetas - name: Pedidos - Notas fiscais description: Endpoints de notas fiscais de pedidos x-folder: pedidos/notas-fiscais - name: Pedidos - Rastreamento description: Endpoints de emails de pedidos x-folder: pedidos/rastreamento - name: Pedidos - Pedido description: Endpoints de pedidos x-folder: pedidos/pedido - name: Promoções - Combos x-folder: promocoes/combos - name: Promoções - Desconto progressivo x-folder: promocoes/desconto-progressivo - name: Promoções - Frete grátis x-folder: promocoes/frete-gratis - name: Promoções - Order Bump x-folder: promocoes/orderbump - name: Promoções - Upsells x-folder: promocoes/upsells - name: Promoções - Carteira x-folder: promocoes/carteira - name: Sistema description: Endpoints informativos do sistema x-folder: sistema - name: Busca - Global x-folder: busca/global - name: Busca - Pedidos x-folder: busca/pedidos - name: Busca - Produtos x-folder: busca/produtos - name: Busca - Clientes x-folder: busca/clientes - name: Busca - Leads x-folder: busca/leads - name: Busca - Carrinhos x-folder: busca/carrinhos - name: Usuários x-folder: usuarios - name: Usuários - Convites x-folder: usuarios/convites - name: Usuários - Grupos x-folder: usuarios/grupos - name: Usuários - Permissões x-folder: usuarios/permissoes - name: Webhooks x-folder: webhooks - name: Loja Virtual - Scripts x-folder: loja-virtual/scripts - name: Modulo - Recurso description: Modulo - Recurso - name: Marketplaces - Atributos description: Marketplaces - Atributos - name: Marketplaces - Anúncios description: Marketplaces - Anúncios - name: Links de Pagamento description: Links de Pagamento - name: Checkout - Contas bancárias description: Checkout - Contas bancárias - name: Checkout - Vendedores description: Checkout - Vendedores - name: Configurações - E-mails description: Configurações - E-mails - name: Logística - Frete Público description: Logística - Frete Público - name: Marketplaces - Categorias description: Marketplaces - Categorias - name: Marketplaces - Contas description: Marketplaces - Contas - name: Marketplaces - Lista de erros description: Marketplaces - Lista de erros - name: Marketplaces description: Marketplaces - name: Métricas - Cashback description: Métricas - Cashback - name: Promoções - Cashbacks description: Promoções - Cashbacks - name: Promoções - Cashback description: Promoções - Cashback - name: Promoções - Cupons de desconto description: Promoções - Cupons de desconto - name: Promoções - Produtos description: Promoções - Produtos - name: Filas description: Filas paths: /{alias}/pricing/promocodes: post: tags: - Promoções - Cupons de desconto summary: Criar cupom description: Cria um novo cupom de desconto operationId: PostPricingPromocodes parameters: - name: alias in: path description: Alias da loja required: true schema: type: string requestBody: description: Parâmetros para criar um cupom de desconto required: true content: application/json: schema: $ref: '#/components/schemas/PromocodeRequest' responses: '201': description: Cupom criado com sucesso content: application/json: schema: $ref: '#/components/schemas/Promocode' '400': description: Dados inválidos fornecidos components: schemas: PromocodeRequest: title: '' description: '' properties: active: description: Ativação do cupom type: boolean for_the_price_of: description: Cupom para o preço de type: boolean accumulate: description: Acumulação do cupom type: boolean once_per_customer: description: Válido apenas uma vez por cliente type: boolean abandoned_cart: description: Cupom para carrinho abandonado type: boolean newsletter: description: Cupom para assinatura de newsletter type: boolean free_shipment: description: Cupom para frete grátis type: boolean ignore_promotion_products: description: Ignorar produtos promocionais type: boolean discount_type: description: Tipo de desconto type: string enum: - p - v value: description: Valor do desconto type: number format: float example: 10 code: description: Código do cupom type: string example: 10OFF quantity: description: Quantidade disponível do cupom type: integer example: 100000 min_value: description: Valor mínimo para aplicação do cupom type: number format: float example: 99.99 start_at: description: Data e hora de início type: string format: date-time example: '2025-06-01 00:00:00' end_at: description: Data e hora de término type: string format: date-time example: '2025-08-10 00:00:00' type: object Promocode: title: Código Promocional description: Representa um código promocional properties: id: type: integer code: type: string example: TEST description: type: string example: '' customer_id: type: integer active: type: boolean expired: type: boolean discount_type: type: string enum: - p - v for_the_price_of: type: boolean cart_default: type: boolean type_increment_value: type: string example: '' value: type: number format: float example: 10 price_products: type: number format: float percent_products: type: number format: float quantity: type: integer example: '100000' total_customers_used: type: integer example: '22' product_quantity: type: integer product_max_quantity: type: integer used: type: integer example: 22 items_count: type: integer min_value: type: number format: float example: 99.99 use_percent: type: number format: float example: 0.02 shipment_percent: type: number format: float accumulate: type: boolean once_per_customer: type: boolean abandoned_cart: type: boolean newsletter: type: boolean payments_ids: example: '[1, 2, 3, 4]' free_shipment: type: boolean ignore_promotion_products: type: boolean type: object securitySchemes: ApiToken: type: apiKey name: User-Token in: header ApiSecretKey: type: apiKey name: User-Secret-Key in: header ````