BigCommerce · Schema

giftCertificate_Base

E-CommerceRetailCatalogOrdersCheckoutPaymentsSaaS

Properties

Name Type Description
to_name string Name of the recipient.
to_email string Email of the recipient.
from_name string Name of the customer who purchased the gift certificate.
from_email string Email of the customer who purchased the gift certificate.
amount string Value of the gift certificate.
View JSON Schema on GitHub

JSON Schema

bigcommerce-giftcertificate-base-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/giftCertificate_Base",
  "title": "giftCertificate_Base",
  "required": [
    "amount",
    "from_email",
    "from_name",
    "to_email",
    "to_name"
  ],
  "type": "object",
  "properties": {
    "to_name": {
      "type": "string",
      "description": "Name of the recipient.",
      "example": "John Doe"
    },
    "to_email": {
      "type": "string",
      "description": "Email of the recipient.",
      "example": "[email protected]"
    },
    "from_name": {
      "type": "string",
      "description": "Name of the customer who purchased the gift certificate.",
      "example": "Jane Doe"
    },
    "from_email": {
      "type": "string",
      "description": "Email of the customer who purchased the gift certificate.",
      "example": "[email protected]"
    },
    "amount": {
      "type": "string",
      "description": "Value of the gift certificate.",
      "example": "10"
    }
  },
  "x-internal": false
}