BigCommerce · Schema

cartLineItemGiftCertificate_Put

E-CommerceRetailCatalogOrdersCheckoutPaymentsSaaS

Properties

Name	Type	Description
theme	string	Currently supports `Birthday`, `Boy`, `Celebration`, `Christmas`, `General`, and `Girl`.
amount	number
sender	object
recipient	object
message	string	Message shown to recipient, as provided by sender.
quantity	number

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/cartLineItemGiftCertificate_Put",
  "title": "cartLineItemGiftCertificate_Put",
  "required": [
    "amount",
    "quantity",
    "recipient",
    "sender",
    "theme"
  ],
  "type": "object",
  "properties": {
    "theme": {
      "type": "string",
      "description": "Currently supports `Birthday`, `Boy`, `Celebration`, `Christmas`, `General`, and `Girl`."
    },
    "amount": {
      "maximum": 1000,
      "minimum": 1,
      "type": "number",
      "description": "",
      "format": "double"
    },
    "sender": {
      "$ref": "#/components/schemas/contactEntity"
    },
    "recipient": {
      "$ref": "#/components/schemas/contactEntity"
    },
    "message": {
      "type": "string",
      "description": "Message shown to recipient, as provided by sender."
    },
    "quantity": {
      "type": "number",
      "description": "",
      "format": "double"
    }
  },
  "x-internal": false
}