Valida um cupom contra um carrinho (prévia do desconto)
/v1/coupons/validateAutentique com o header SelectKey: a chave sk_test_ opera no sandbox, a sk_live_ em produção. Como autenticar.
Corpo da requisição
codestringobrigatórioO código do cupom.
amountintegerobrigatórioValor do carrinho em centavos, antes do desconto.
itemIdsstring[]Ids das variantes no carrinho — para cupons restritos a itens específicos.
itemCountintegerNúmero de itens no carrinho.
customerIdstringO comprador — para cupons limitados a um uso por cliente ou a clientes específicos.
Respostas
200Sucesso
codestringobrigatórioO código do cupom.
validbooleanobrigatórioSe o cupom vale para este carrinho.
reasonstringobrigatóriopode ser nuloPor que não vale;
nullquando válido.discountobjectobrigatóriopode ser nuloO desconto que o cupom aplicaria;
nullquando não é válido.+3 campos de
discounttypestringobrigatóriopercentageouflat.Valores:percentageflatvalueintegerobrigatórioO desconto, em centavos.
percentagenumberobrigatórioO desconto como percentual do valor do carrinho.
chargedAmountintegerobrigatóriopode ser nuloValor do carrinho depois do desconto (centavos).
originalAmountintegerobrigatóriopode ser nuloValor do carrinho antes do desconto (centavos).
400Requisição inválida (validação)
errorobjectobrigatório+8 campos de
errorcodestringobrigatórioparamsobject[]statusstringobrigatóriodetailsstringmessagestringobrigatóriocategorystringobrigatórioValores:validationauthenticationauthorizationpaymentclientserverrate_limitpendingresourcestringobrigatóriostatusCodeintegerobrigatório
401Não autenticado (credencial ausente ou inválida)
errorobjectobrigatório+8 campos de
errorcodestringobrigatórioparamsobject[]statusstringobrigatóriodetailsstringmessagestringobrigatóriocategorystringobrigatórioValores:validationauthenticationauthorizationpaymentclientserverrate_limitpendingresourcestringobrigatóriostatusCodeintegerobrigatório
403Sem permissão
errorobjectobrigatório+8 campos de
errorcodestringobrigatórioparamsobject[]statusstringobrigatóriodetailsstringmessagestringobrigatóriocategorystringobrigatórioValores:validationauthenticationauthorizationpaymentclientserverrate_limitpendingresourcestringobrigatóriostatusCodeintegerobrigatório
500Erro interno do servidor
errorobjectobrigatório+8 campos de
errorcodestringobrigatórioparamsobject[]statusstringobrigatóriodetailsstringmessagestringobrigatóriocategorystringobrigatórioValores:validationauthenticationauthorizationpaymentclientserverrate_limitpendingresourcestringobrigatóriostatusCodeintegerobrigatório