BigCommerce · Schema

Item Gift Certificate

E-CommerceRetailCatalogOrdersCheckoutPaymentsSaaS

Properties

Name	Type	Description
amount	number	Value must be between 1.00 and 1,000.00 in the storeʼs default currency.
id	string	ID of this gift certificate.
isTaxable	boolean	Whether or not the gift certificate is taxable.
message	string	Message that will be sent to the gift certificate's recipient. Limited to 200 characters.
name	string	GiftCertificate-provided name that will appear in the control panel.
recipient	object
sender	object
theme	string	Currently supports `Birthday`, `Boy`, `Celebration`, `Christmas`, `General`, and `Girl`.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/responseCartLineItemsGiftCertificates",
  "title": "Item Gift Certificate",
  "required": [
    "amount",
    "recipient",
    "sender",
    "theme"
  ],
  "type": "object",
  "properties": {
    "amount": {
      "type": "number",
      "description": "Value must be between 1.00 and 1,000.00 in the store\u02bcs default currency."
    },
    "id": {
      "type": "string",
      "description": "ID of this gift certificate."
    },
    "isTaxable": {
      "type": "boolean",
      "description": "Whether or not the gift certificate is taxable."
    },
    "message": {
      "type": "string",
      "description": "Message that will be sent to the gift certificate's recipient. Limited to 200 characters."
    },
    "name": {
      "type": "string",
      "description": "GiftCertificate-provided name that will appear in the control panel."
    },
    "recipient": {
      "$ref": "#/components/schemas/responseCartLineItemsGiftCertificatesRecipient"
    },
    "sender": {
      "$ref": "#/components/schemas/responseCartLineItemsGiftCertificatesSender"
    },
    "theme": {
      "type": "string",
      "description": "Currently supports `Birthday`, `Boy`, `Celebration`, `Christmas`, `General`, and `Girl`."
    }
  },
  "x-internal": false
}