YAyampi
Promoções - Cupons de desconto

Criar cupom

Changed on

Cria um novo cupom de desconto

post/{alias}/pricing/promocodes

Request

  • Base URL
    https://api.dooki.com.br/v2
  • URL
    https://api.dooki.com.br/v2/{alias}/pricing/promocodes
  • Auth
    API key in header User-Token and API key in header User-Secret-Key

Path parameters

aliasstring required

Alias da loja

Request body

activeboolean required

Ativação do cupom

for_the_price_ofboolean

Cupom para o preço de

accumulateboolean

Acumulação do cupom

once_per_customerboolean

Válido apenas uma vez por cliente

abandoned_cartboolean

Cupom para carrinho abandonado

newsletterboolean

Cupom para assinatura de newsletter

free_shipmentboolean

Cupom para frete grátis

ignore_promotion_productsboolean

Ignorar produtos promocionais

discount_type'p' | 'v' required

Tipo de desconto

valuenumber float required

Valor do desconto

codestring required

Código do cupom

quantityinteger required

Quantidade disponível do cupom

min_valuenumber float required

Valor mínimo para aplicação do cupom

start_atstring date-time required

Data e hora de início

end_atstring date-time required

Data e hora de término

freebie_idinteger nullable

Brinde (rule 'promocode') concedido pelo cupom

advertiseboolean

Divulgar o cupom com brinde no checkout

Example request

{
  "value": 10,
  "code": "10OFF",
  "quantity": 100000,
  "min_value": 99.99,
  "start_at": "2025-06-01 00:00:00",
  "end_at": "2025-08-10 00:00:00"
}

Response

Cupom criado com sucesso

idinteger

ID do cupom.

codestring

Código digitado pelo cliente no carrinho para aplicar o cupom. Único na loja, com no mínimo 3 e no máximo 40 caracteres.

descriptionstring

Descrição interna do cupom, com até 60 caracteres. Emojis são removidos ao salvar.

customer_idinteger

ID do cliente para quem o cupom é exclusivo. Quando nulo, o cupom vale para qualquer cliente.

activeboolean

Indica se o cupom está ativo.

expiredboolean

Indica se a data de término do cupom já passou.

discount_type'p' | 'v'

Tipo do desconto do cupom: p para percentual e v para valor fixo em reais.

for_the_price_ofboolean

Indica se o cupom é do tipo 'pelo preço de', em que cada produto elegível passa a custar o valor de price_products.

cart_defaultboolean

Indica se o cupom é aplicado automaticamente no carrinho. Um cupom percentual de 100% ou mais nunca é tratado como padrão.

type_increment_valuestring

Tipo do desconto como está gravado no cupom, com os mesmos valores de discount_type (p ou v).

valuenumber float

Valor do desconto: percentual quando discount_type for p, ou valor em reais quando for v.

price_productsnumber float

Preço aplicado a cada produto elegível quando for_the_price_of for verdadeiro. Obrigatório nesse caso.

percent_productsnumber float

Percentual de desconto aplicado ao preço de cada produto elegível, usado em vez de price_products quando for maior que zero.

quantityinteger

Quantidade total de usos disponíveis do cupom. O cupom deixa de valer quando used alcança esse número.

total_customers_usedinteger

Quantidade de clientes distintos que já usaram o cupom.

product_quantityinteger

Quantidade de produtos elegíveis que o cupom 'pelo preço de' considera no cálculo do total.

product_max_quantityinteger

Quantidade máxima de produtos elegíveis a que o cupom se aplica.

usedinteger

Quantidade de vezes que o cupom já foi usado.

items_countinteger

Quantidade de itens do carrinho considerada na regra do cupom. Campo legado: é gravado e devolvido, mas nenhuma regra desta API o aplica.

min_valuenumber float

Valor mínimo do subtotal do carrinho, em reais, para o cupom poder ser aplicado.

use_percentnumber float

Proporção de uso do cupom, entre os usos já feitos e o total disponível.

shipment_percentnumber float

Percentual de desconto aplicado ao frete, usado quando o cupom desconta no frete em vez de descontar nos produtos.

accumulateboolean

Indica se o cupom pode ser acumulado com outras promoções da loja.

once_per_customerboolean

Indica se cada cliente pode usar o cupom uma única vez.

abandoned_cartboolean

Indica se o cupom está vinculado a alguma configuração de recuperação de carrinho abandonado.

newsletterboolean

Indica se o cupom é entregue ao cliente que se inscreve na newsletter da loja.

payments_idsstring

IDs dos meios de pagamento em que o cupom é aceito.

free_shipmentboolean

Indica se o cupom concede frete grátis em vez de desconto no valor do pedido.

ignore_promotion_productsboolean

Indica se o cupom deixa de valer para produtos que já estão em promoção.

freebie_idinteger nullable

Brinde concedido pelo cupom

advertiseboolean

Divulgar o cupom com brinde no checkout

Example response

{
  "code": "TEST",
  "value": 10,
  "used": 22,
  "min_value": 99.99,
  "use_percent": 0.02,
  "payments_ids": "[1, 2, 3, 4]"
}

Changes

  • bbafb577e11cRevision changes
    • breaking

      the request property became required

    • breaking

      the request property became required

    • breaking

      the request property became required

    • breaking

      the request property became required

    • breaking

      the request property became required

    • breaking

      the request property became required

    • breaking

      the request property became required

    • breaking

      the request property became required

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status