Acesso Comercial / Docs / Storefront / API
Ctrl K
MUTATION

checkCouponOnShoppingCart

Verifica se um código de cupom é válido para o carrinho atual sem aplicá-lo.

Input

CheckCouponOnShoppingCartMutationInput!

CampoTipoDescrição
hostnameString!Hostname da loja.
codeString!Código do cupom a verificar.

Retorno

CampoTipoDescrição
couponCouponDados do cupom se válido.
isValidBooleanSe o cupom é válido para o carrinho.

Mutation

GraphQL
mutation CheckCoupon($input: CheckCouponOnShoppingCartMutationInput!) {
  checkCouponOnShoppingCart(input: $input) {
    isValid
    coupon {
      code
      discountPercentage
      discountValue
    }
  }
}

Variables

JSON
{
  "input": {
    "hostname": "minha-loja",
    "code": "DESCONTO10"
  }
}

Resposta

JSON
{
  "data": {
    "checkCouponOnShoppingCart": {
      "isValid": true,
      "coupon": {
        "code": "DESCONTO10",
        "discountPercentage": 10,
        "discountValue": null
      }
    }
  }
}

Fetch

JavaScript
const response = await fetch('/graphql', {
  method: 'POST',
  credentials: 'include',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({
    query: `mutation($input: CheckCouponOnShoppingCartInput!) {
      checkCouponOnShoppingCart(input: $input) {
        shoppingCart { id totalPrice totalDiscount coupon { code discountPercentage } }
      }
    }`,
    variables: { input: { hostname: "minha-loja", couponCode: "DESCONTO10" } }
  })
});

cURL

Bash
curl -X POST https://minha-loja.com/graphql \
  -H "Content-Type: application/json" \
  -b "authJwtClient=YOUR_SESSION_COOKIE" \
  -d '{"query":"mutation { checkCouponOnShoppingCart(input: { hostname: \"minha-loja\", couponCode: \"DESCONTO10\" }) { shoppingCart { totalDiscount } } }"}'