VTEX · Schema

response1

Items information.

CommerceE-CommerceRetailMarketplacePayments

Properties

Name Type Description
id string Gift card identification.
redemptionToken string Gift card redemption token.
redemptionCode string Gift card identification code used at checkout. Minimum of 6 characters.
balance number Gift card current balance. For newly created gift cards, the balance will be 0.0.
emissionDate string Gift card creation date.
expiringDate string Gift card expiration date.
discount boolean Discount applied on item.
transaction object
View JSON Schema on GitHub

JSON Schema

vtex-response1-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/response1",
  "title": "response1",
  "description": "Items information.",
  "required": [
    "id",
    "redemptionToken",
    "redemptionCode",
    "balance",
    "emissionDate",
    "expiringDate",
    "discount",
    "transaction"
  ],
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Gift card identification."
    },
    "redemptionToken": {
      "type": "string",
      "description": "Gift card redemption token."
    },
    "redemptionCode": {
      "type": "string",
      "description": "Gift card identification code used at checkout. Minimum of 6 characters."
    },
    "balance": {
      "type": "number",
      "description": "Gift card current balance. For newly created gift cards, the balance will be 0.0."
    },
    "emissionDate": {
      "type": "string",
      "description": "Gift card creation date."
    },
    "expiringDate": {
      "type": "string",
      "description": "Gift card expiration date."
    },
    "discount": {
      "type": "boolean",
      "description": "Discount applied on item."
    },
    "transaction": {
      "$ref": "#/components/schemas/Transaction"
    }
  },
  "example": {
    "id": "3b1abc17-988e-4a14-8b7f-31fc6a5b955c_24",
    "redemptionToken": "XTYB-IOBW-WLJE-SEYG",
    "redemptionCode": "XTYB-IOBW-WLJE-SEYG",
    "balance": 5.9,
    "emissionDate": "2018-03-20T09:37:13.797",
    "expiringDate": "2020-03-18T11:42:55.183",
    "discount": false,
    "transaction": {
      "href": "/gatewayqa/giftcards/3b1abc17-988e-4a14-8b7f-31fc6a5b955c_24/transactions"
    }
  }
}