VTEX · Schema

CreateGiftCardRequest

CommerceE-CommerceRetailMarketplacePayments

Properties

Name	Type	Description
relationName	string	Represents the relationship between the client and the store.
expiringDate	string	It must be in the format `YYYY-MM-DDThh:mm:ss.fff` (ISO 8601 format).
caption	string	Field to be filled in if a loyalty program must be created for the gift card.
profileId	string	Client ID. You can use the customer's registered email or the `userId` parameter which can be found in the [Master Data](https://help.vtex.com/en/tutorial/master-data--4otjBnR27u4WUIciQsmkAw).
currencyCode	string	Currency code in ISO 4217.
restrictedToOwner	boolean	The gift card can only be used for a specified client's ID.
multipleCredits	boolean	The gift card balance can be changed.
multipleRedemptions	boolean	The gift card can be used to make new purchases until its value is completely used.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CreateGiftCardRequest",
  "title": "CreateGiftCardRequest",
  "type": "object",
  "required": [
    "relationName",
    "expiringDate",
    "caption",
    "profileId"
  ],
  "properties": {
    "relationName": {
      "type": "string",
      "description": "Represents the relationship between the client and the store.",
      "example": "loyalty-program"
    },
    "expiringDate": {
      "type": "string",
      "description": "It must be in the format `YYYY-MM-DDThh:mm:ss.fff` (ISO 8601 format).",
      "example": "2020-09-01T13:15:30Z"
    },
    "caption": {
      "type": "string",
      "description": "Field to be filled in if a loyalty program must be created for the gift card.",
      "example": "rewards program"
    },
    "profileId": {
      "type": "string",
      "description": "Client ID. You can use the customer's registered email or the `userId` parameter which can be found in the [Master Data](https://help.vtex.com/en/tutorial/master-data--4otjBnR27u4WUIciQsmkAw).",
      "example": "92de2449-0e02-4ca9-a4aa-a09cc9d8f7ff"
    },
    "currencyCode": {
      "type": "string",
      "description": "Currency code in ISO 4217.",
      "example": "USD"
    },
    "restrictedToOwner": {
      "type": "boolean",
      "description": "The gift card can only be used for a specified client's ID.",
      "example": false
    },
    "multipleCredits": {
      "type": "boolean",
      "description": "The gift card balance can be changed.",
      "example": false
    },
    "multipleRedemptions": {
      "type": "boolean",
      "description": "The gift card can be used to make new purchases until its value is completely used.",
      "example": false
    }
  }
}