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. |
| relationName | string | Field to be filled in when it is not necessary to use a loyalty program for the gift card. Note that a new `relationNamevalue` is required for each new gift card to be created. |
| emissionDate | string | Gift card creation date. |
| expiringDate | string | Gift card expiration date. |
| caption | string | Field to be filled in if a loyalty program must be created for the Gift Card. |
| currencyCode | string | Currency code in ISO 4217. |
| transactions | object |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/response",
"title": "response",
"type": "object",
"required": [
"id",
"redemptionToken",
"redemptionCode",
"balance",
"relationName",
"emissionDate",
"expiringDate",
"caption",
"transactions"
],
"properties": {
"id": {
"type": "string",
"description": "Gift card identification.",
"example": "954"
},
"redemptionToken": {
"type": "string",
"description": "Gift card redemption token.",
"example": "32ScL57220Vapb8pc50HJ3mWH1cl1L8x"
},
"redemptionCode": {
"type": "string",
"description": "Gift card identification code used at checkout. Minimum of 6 characters.",
"example": "***********ASDQ"
},
"balance": {
"type": "number",
"description": "Gift card current balance. For newly created gift cards, the balance will be 0.0.",
"example": 0
},
"relationName": {
"type": "string",
"description": "Field to be filled in when it is not necessary to use a loyalty program for the gift card. Note that a new `relationNamevalue` is required for each new gift card to be created.",
"example": "cardName"
},
"emissionDate": {
"type": "string",
"description": "Gift card creation date.",
"example": "2014-04-24T20:22:58.163"
},
"expiringDate": {
"type": "string",
"description": "Gift card expiration date.",
"example": "2016-01-01T00:00:00"
},
"caption": {
"type": "string",
"description": "Field to be filled in if a loyalty program must be created for the Gift Card.",
"example": "VTEX Loyalty Program"
},
"currencyCode": {
"type": "string",
"description": "Currency code in ISO 4217.",
"example": "USD"
},
"transactions": {
"$ref": "#/components/schemas/Transactions"
}
}
}
Work with this as data
Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for schemas
4 MCP tools reach this
find_json_schemasBrowse and filter every JSON Schema in the catalog.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/vtex-response"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"
Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.