setGiftOptionsOnCart mutation

The setGiftOptionsOnCart mutation allows the buyer to set the following gift options on the cart level:

• Gift messages
• Gift wrapping
• A gift receipt to accompany the order
• A printed card to accompany the order

To remove a gift message, set the gift_message object to null. To remove gift wrapping, set the gift_wrapping_id attribute to null.

Use the updateCartItems mutation to set gift messages and gift wrapping on individual items.

These options are configured on the Stores > Configuration > Sales > Sales > Gift Options screen. To determine whether these options are enabled, specify these attributes in the storeConfig query.

• allow_gift_receipt
• allow_gift_wrapping_on_order
• allow_printed_card
• cart_gift_wrapping
• cart_printed_card
• printed_card_price
• sales_gift_wrapping
• sales_printed_card

Gift wrapping is available for simple, configurable, bundle products as well as physical gift cards.

Syntax

mutation: {setGiftOptionsOnCart(input: SetGiftOptionsOnCartInput): SetGiftOptionsOnCartOutput}

Reference

The setGiftOptionsOnCart reference provides detailed information about the types and fields defined in this mutation.

Example usage

The following example adds a gift message, gift wrapping, and a gift receipt to the cart.

Request:

Copy
mutation {
  setGiftOptionsOnCart(
    input: {
      cart_id: "8k0Q4MpH2IGahWrTRtqM61YV2MtLPApz"
      gift_message: {
        to: "Alex"
        from: "Veronica"
        message: "Happy Birthday!"
      }
      gift_wrapping_id: "Mg=="
      gift_receipt_included: true
      printed_card_included: false
    }
  ) {
    cart {
      id
      gift_message {
        to
        from
        message
      }
      gift_wrapping {
        uid
      }
      gift_receipt_included
      printed_card_included
      itemsV2 {
        items {
          quantity
          prices {
            price {
              value
              currency
            }
          }
        }
        total_count
        page_info {
          page_size
          current_page
          total_pages
        }
      }
      prices {
        gift_options {
          gift_wrapping_for_order {
            value
            currency
          }
        }
        grand_total {
          value
          currency
        }
      }
    }
  }
}
Copied to your clipboard
mutation {
  setGiftOptionsOnCart(
    input: {
      cart_id: "8k0Q4MpH2IGahWrTRtqM61YV2MtLPApz"
      gift_message: {
        to: "Alex"
        from: "Veronica"
        message: "Happy Birthday!"
      }
      gift_wrapping_id: "Mg=="
      gift_receipt_included: true
      printed_card_included: false
    }
  ) {
    cart {
      id
      gift_message {
        to
        from
        message
      }
      gift_wrapping {
        uid
      }
      gift_receipt_included
      printed_card_included
      itemsV2 {
        items {
          quantity
          prices {
            price {
              value
              currency
            }
          }
        }
        total_count
        page_info {
          page_size
          current_page
          total_pages
        }
      }
      prices {
        gift_options {
          gift_wrapping_for_order {
            value
            currency
          }
        }
        grand_total {
          value
          currency
        }
      }
    }
  }
}

Response:

Copy
{
  "data": {
    "setGiftOptionsOnCart": {
      "cart": {
        "id": "8k0Q4MpH2IGahWrTRtqM61YV2MtLPApz",
        "gift_message": {
            "to": "Alex"
            "from": "Veronica"
            "message": "Happy Birthday!"
        }
        "gift_wrapping": {
          "uid": "Mg=="
        },
        "gift_receipt_included": true,
        "printed_card_included": false,
        "itemsV2": {
          "items": [
            {
              "quantity": 1,
              "prices": {
                "price": {
                  "value": 32,
                  "currency": "USD"
                }
              }
            },
            {
              "quantity": 1,
              "prices": {
                "price": {
                  "value": 84,
                  "currency": "USD"
                }
              }
            }
          ],
          "total_count": 2,
          "page_info": {
            "page_size": 20,
            "current_page": 1,
            "total_pages": 1
          }
        },
        "prices": {
          "gift_options": {
            "gift_wrapping_for_order": {
              "value": 7,
              "currency": "USD"
            }
          },
          "grand_total": {
            "value": 132.57,
            "currency": "USD"
          }
        }
      }
    }
  }
}
Copied to your clipboard
{
  "data": {
    "setGiftOptionsOnCart": {
      "cart": {
        "id": "8k0Q4MpH2IGahWrTRtqM61YV2MtLPApz",
        "gift_message": {
            "to": "Alex"
            "from": "Veronica"
            "message": "Happy Birthday!"
        }
        "gift_wrapping": {
          "uid": "Mg=="
        },
        "gift_receipt_included": true,
        "printed_card_included": false,
        "itemsV2": {
          "items": [
            {
              "quantity": 1,
              "prices": {
                "price": {
                  "value": 32,
                  "currency": "USD"
                }
              }
            },
            {
              "quantity": 1,
              "prices": {
                "price": {
                  "value": 84,
                  "currency": "USD"
                }
              }
            }
          ],
          "total_count": 2,
          "page_info": {
            "page_size": 20,
            "current_page": 1,
            "total_pages": 1
          }
        },
        "prices": {
          "gift_options": {
            "gift_wrapping_for_order": {
              "value": 7,
              "currency": "USD"
            }
          },
          "grand_total": {
            "value": 132.57,
            "currency": "USD"
          }
        }
      }
    }
  }
}

Errors

Last updated 3/14/2024

Was this helpful?

Yes

No