SelectwinSelectwin

Valida um cupom contra um carrinho (prévia do desconto)

POST/v1/coupons/validate

Autentique com o header SelectKey: a chave sk_test_ opera no sandbox, a sk_live_ em produção. Como autenticar.

Corpo da requisição

  • codestringobrigatório

    O código do cupom.

  • amountintegerobrigatório

    Valor do carrinho em centavos, antes do desconto.

  • itemIdsstring[]

    Ids das variantes no carrinho — para cupons restritos a itens específicos.

  • itemCountinteger

    Número de itens no carrinho.

  • customerIdstring

    O comprador — para cupons limitados a um uso por cliente ou a clientes específicos.

Respostas

200Sucesso
  • codestringobrigatório

    O código do cupom.

  • validbooleanobrigatório

    Se o cupom vale para este carrinho.

  • reasonstringobrigatóriopode ser nulo

    Por que não vale; null quando válido.

  • discountobjectobrigatóriopode ser nulo

    O desconto que o cupom aplicaria; null quando não é válido.

    +3 campos de discount
    • typestringobrigatório

      percentage ou flat.

      Valores:percentageflat
    • valueintegerobrigatório

      O desconto, em centavos.

    • percentagenumberobrigatório

      O desconto como percentual do valor do carrinho.

  • chargedAmountintegerobrigatóriopode ser nulo

    Valor do carrinho depois do desconto (centavos).

  • originalAmountintegerobrigatóriopode ser nulo

    Valor do carrinho antes do desconto (centavos).

400Requisição inválida (validação)
  • errorobjectobrigatório
    +8 campos de error
    • codestringobrigatório
    • paramsobject[]
    • statusstringobrigatório
    • detailsstring
    • messagestringobrigatório
    • categorystringobrigatório
      Valores:validationauthenticationauthorizationpaymentclientserverrate_limitpending
    • resourcestringobrigatório
    • statusCodeintegerobrigatório
401Não autenticado (credencial ausente ou inválida)
  • errorobjectobrigatório
    +8 campos de error
    • codestringobrigatório
    • paramsobject[]
    • statusstringobrigatório
    • detailsstring
    • messagestringobrigatório
    • categorystringobrigatório
      Valores:validationauthenticationauthorizationpaymentclientserverrate_limitpending
    • resourcestringobrigatório
    • statusCodeintegerobrigatório
403Sem permissão
  • errorobjectobrigatório
    +8 campos de error
    • codestringobrigatório
    • paramsobject[]
    • statusstringobrigatório
    • detailsstring
    • messagestringobrigatório
    • categorystringobrigatório
      Valores:validationauthenticationauthorizationpaymentclientserverrate_limitpending
    • resourcestringobrigatório
    • statusCodeintegerobrigatório
500Erro interno do servidor
  • errorobjectobrigatório
    +8 campos de error
    • codestringobrigatório
    • paramsobject[]
    • statusstringobrigatório
    • detailsstring
    • messagestringobrigatório
    • categorystringobrigatório
      Valores:validationauthenticationauthorizationpaymentclientserverrate_limitpending
    • resourcestringobrigatório
    • statusCodeintegerobrigatório

Preferências de cookies

Hoje o site usa só cookies essenciais: nenhuma ferramenta de medição ou de anúncios está ligada, e nada é compartilhado com terceiros. Se isso mudar, você decide aqui antes de qualquer coisa ser carregada.

  • Mantêm o site funcionando: segurança, a sua escolha sobre cookies e preferências como a versão da documentação. Não dependem de consentimento.

    Sempre ativos