CouponDetails
- activeType: booleanrequired
truequando o cupom está ativado pela loja. Um cupom ativo ainda pode estar fora da validade ou ter atingido o limite de usos. - allowsType: boolean
_combos requiredtruequando o cupom pode ser usado em combos. - allowsType: boolean
_marketplace _customers requiredtruequando o cupom vale para novos clientes vindos de marketplace. - allowsType: boolean
_promotions requiredtruequando o cupom pode ser usado em produtos em promoção. - availabilityType: array of CouponAvailabilityrequiredProperties: 3
Janelas de horário em que o cupom vale. Lista vazia significa a qualquer hora.
- categoryType: array of integer
_ids requiredCategorias permitidas, quando
restricts_productsétrue. - crmType: array of string
_classifications requiredPara
specific_customers: classificações de CRM aceitas. - crmType: array of string
_tags requiredPara
specific_customers: tags de CRM aceitas. - discountType: boolean
_is _percent requiredtruequandodiscount_valueé um percentual. - discountType: string
_target requiredSobre o que o desconto é aplicado:
cart(produtos),delivery(taxa de entrega),total(pedido inteiro) ounone(cupom só de prêmio). - firstType: boolean
_order _only requiredtruequando o cupom vale apenas no primeiro pedido do cliente. - forbiddenType: array of integer
_category _ids requiredCategorias com as quais o cupom não pode ser usado.
- forbiddenType: array of integer
_product _ids requiredProdutos com os quais o cupom não pode ser usado.
- idType: integerrequired
Id do cupom. Passe-o para
/api/coupon/details/. - paymentType: array of integer
_method _ids requiredFormas de pagamento aceitas (ids de
/api/store/info/). - productType: array of integer
_ids requiredProdutos permitidos, quando
restricts_productsétrue. - restrictsType: boolean
_payment _methods requiredtruequando o cupom só vale para as formas empayment_method_ids. - restrictsType: boolean
_products requiredtruequando o cupom só vale para os produtos/categorias listados emproduct_ids/category_ids. - reusableType: booleanrequired
truequando o mesmo cliente pode usar o cupom mais de uma vez. - showType: boolean
_in _app requiredtruequando o cupom é exibido no app/site da loja. - showType: boolean
_in _roulette requiredtruequando o cupom pode ser sorteado na roleta. - showType: boolean
_in _suitbot requiredtruequando o cupom é oferecido pelo SuitBot. - targetType: string
_audience requiredPúblico alvo:
all_customers,new_customers,birthday_customersouspecific_customers. - usageType: integer
_count requiredQuantas vezes o cupom já foi usado (pedidos pendentes, cancelados ou abandonados não contam).
- birthdayType: integernullable
_redeem _days Para
birthday_customers: dias que o aniversariante tem para usar o cupom. - codeType: stringnullable
Código que o cliente digita para usar o cupom.
- descriptionType: stringnullable
Descrição do cupom.
- discountType: stringnullable
_value Valor do desconto: em BRL, ou percentual quando
discount_is_percentétrue. - endsType: stringFormat: datenullable
_on Último dia de validade.
- maximumType: stringnullable
_discount Teto do desconto em BRL, para cupons percentuais.
- minimumType: stringnullable
_order _value Subtotal mínimo (sem entrega) para usar o cupom, em BRL.
- orderType: array of stringnullable
_types Tipos de pedido aceitos (mesmos códigos de
order_typeem/api/order/list).nullsignifica todos. - prizeType: integernullable
_product _id Id do produto concedido como prêmio, quando o cupom dá um produto.
- scheduleType: array of stringnullable
_types Modalidades aceitas:
standard(pedido imediato),same_day(agendado para o mesmo dia) ouanother_day(agendado para outro dia).nullsignifica todas. - startsType: stringFormat: datenullable
_on Primeiro dia de validade.
- usageType: integernullable
_limit Total de usos permitidos;
nullsignifica ilimitado.