For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.

Docs API Reference Learn Community Changelog

Docs API Reference Learn Community Changelog

- About Our APIs
REST
GraphQL
MCP
- Overview

GraphQL Storefront Mutations

previewGiftCertificate

Example Query

1 mutation ExampleMutation($input: GiftCertificatePreviewInput) {
2   previewGiftCertificate(input: $input) {
3     html
4     errors
5   }
6 }

Variables

1 {
2   "input": {
3     "amount": 0,
4     "currencyCode": "ADP",
5     "message": "example",
6     "theme": "BIRTHDAY",
7     "sender": {
8       "name": "example"
9     },
10     "recipient": {
11       "name": "example"
12     }
13   }
14 }

Example response

1 {
2   "data": {
3     "previewGiftCertificate": {
4       "html": "example",
5       "errors": [
6         {
7           "path": [
8             "example"
9           ],
10           "message": "example"
11         }
12       ]
13     }
14   }
15 }

Mutation to preview a gift certificate.

Was this page helpful?

searchProductEvent

registerCompany

Arguments

inputGiftCertificatePreviewInputRequired

Gift certificate preview input.

Returns

a GiftCertificatePreview

errorslist of GiftCertificatePreviewErrors

A list of gift certificate preview errors.

htmlString

The HTML content of the gift certificate preview.