Acesso Comercial / Docs / Storefront / API
Ctrl K
OBJECT

Coupon

Cupom de desconto aplicável ao carrinho de compras.

Campos

CampoTipoDescrição
codeString!Código do cupom.
discountPercentageFloatPercentual de desconto (ex: 10 para 10%). Null se desconto fixo.
discountValueFloatValor fixo de desconto em centavos. Null se percentual.

Cupom no carrinho

GraphQL
query {
  shoppingCart(hostname: "minha-loja") {
    coupon {
      code
      discountPercentage
      discountValue
    }
    totalDiscount
    totalPrice
  }
}

Resposta (desconto percentual)

JSON
{
  "data": {
    "shoppingCart": {
      "coupon": {
        "code": "DESCONTO10",
        "discountPercentage": 10,
        "discountValue": null
      },
      "totalDiscount": 899,
      "totalPrice": 8091
    }
  }
}

Resposta (desconto fixo)

JSON
{
  "coupon": {
    "code": "PROMO500",
    "discountPercentage": null,
    "discountValue": 500
  }
}