applyGiftCardToCart mutation

The applyGiftCardToCart mutation applies a pre-defined gift card code to the specified cart.

Syntax

1
2
3
4
5
6
7
mutation {
  applyGiftCardToCart(
    input: ApplyGiftCardToCartInput
  ) {
    ApplyGiftCardToCartOutput
  }
}

Example usage

The following example adds a gift card with the code 0330CEIVTLB4 to the cart. The gift card has a value of $20.

Request:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
mutation {
  applyGiftCardToCart(
    input: {
      cart_id: "lY8PnKhlHBGc4WS5v0Y3dWjxiA5PvvgY"
      gift_card_code: "0330CEIVTLB4"
    }
  ) {
    cart {
      applied_gift_cards {
        applied_balance {
          value
          currency
        }
        code
        current_balance {
          value
          currency
        }
        expiration_date
      }
    }
  }
}

Response:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
{
  "data": {
    "applyGiftCardToCart": {
      "cart": {
        "applied_gift_cards": [
          {
            "applied_balance": {
              "value": 20,
              "currency": "USD"
            },
            "code": "0330CEIVTLB4",
            "current_balance": {
              "value": 20,
              "currency": "USD"
            },
            "expiration_date": null
          }
        ]
      }
    }
  }
}

Input attributes

The applyGiftCardToCart mutation requires the cart_id and gift_card_code.

ApplyGiftCardToCartInput object

The ApplyGiftCardToCartInput object must contain the following attributes:

Output attributes

The ApplyGiftCardToCartOutput object contains the Cart object.

Cart object

Cart query output provides more information about the Cart object.