BigCommerce · Schema

Item Gift Certificate

E-CommerceRetailCatalogOrdersCheckoutPaymentsSaaS

Properties

Name	Type	Description
id	string
name	string	Name provided for the gift certificate that will appear in the control panel.
theme	string	The theme of the gift certificate. The following options are available:`birthday.html`, `boy.html`, `celebration.html`, `christmas.html`, `general.html`, and `girl.html`.
amount	number	Value must be between 1.00 and 1,000.00 in the store’s default currency.
is_taxable	boolean
sender	object
recipient	object
message	string	The message included in the gift certificate is limited to 200 characters.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ItemGiftCertificateGet",
  "title": "Item Gift Certificate",
  "type": "object",
  "x-internal": false,
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string",
      "description": "Name provided for the gift certificate that will appear in the control panel."
    },
    "theme": {
      "type": "string",
      "description": "The theme of the gift certificate. The following options are available:`birthday.html`, `boy.html`, `celebration.html`, `christmas.html`, `general.html`, and `girl.html`."
    },
    "amount": {
      "type": "number",
      "description": "Value must be between 1.00 and 1,000.00 in the store\u2019s default currency."
    },
    "is_taxable": {
      "type": "boolean"
    },
    "sender": {
      "title": "Contact Entity",
      "type": "object",
      "properties": {
        "name": {
          "type": "string"
        },
        "email": {
          "type": "string"
        }
      }
    },
    "recipient": {
      "title": "Contact Entity",
      "type": "object",
      "properties": {
        "name": {
          "type": "string"
        },
        "email": {
          "type": "string"
        }
      }
    },
    "message": {
      "type": "string",
      "description": "The message included in the gift certificate is limited to 200 characters."
    }
  }
}