applyStoreCreditToCart mutation

The applyStoreCreditToCart mutation applies store credit to the specified cart. Store credit must be enabled on the store to run this mutation.

Store credit is an amount that the merchant applies to a customer account as a result of a refund or similar transaction. If gift cards are enabled for a store, then a customer receives store credit when redeeming a gift card. No matter how the customer obtains store credit, these funds can be used to pay for purchases.

The amount returned in the current_balance indicates how much store credit at the time you run the applyStoreCreditToCart mutation. This amount is not decreased until you place the order.

If the amount of available store credit equals or exceeds the grand total of the quote, set the payment method to free in the setPaymentMethodOnCart mutation.

Syntax

1
2
3
4
5
6
7
mutation {
  applyStoreCreditToCart(
    input: ApplyStoreCreditToCartInput
  ) {
    ApplyStoreCreditToCartOutput
  }
}

Example usage

In the following example, the customer starts with $10 of store credit. The subtotal of the items in the cart before applying the store credit plus shipping and tax is $34.64. The grand total on the cart after applying the store credit is $24.64.

Request:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
mutation {
  applyStoreCreditToCart(
    input: {
      cart_id: "4HHaKzxpKM2ZwD0IcheRfcPNBWS3OvRM"
    }
  ) {
    cart {
      applied_store_credit {
        applied_balance {
          currency
          value
        }
        current_balance {
          currency
          value
        }
      }
      prices {
        grand_total {
          currency
          value
        }
      }
    }
  }
}

Response:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
{
  "data": {
    "applyStoreCreditToCart": {
      "cart": {
        "applied_store_credit": {
          "applied_balance": {
            "currency": "USD",
            "value": 34.64
          },
          "current_balance": {
            "currency": "USD",
            "value": 10
          }
        },
        "prices": {
          "grand_total": {
            "currency": "USD",
            "value": 24.64
          }
        }
      }
    }
  }
}

Input attributes

The ApplyStoreCreditToCartInput object must contain the following attributes.

Output attributes

The ApplyStoreCreditToCartOutput object returns the Cart object.

Cart object

Cart query output provides more information about the Cart object.